ollama.py 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834
  1. # TODO: Implement a more intelligent load balancing mechanism for distributing requests among multiple backend instances.
  2. # Current implementation uses a simple round-robin approach (random.choice). Consider incorporating algorithms like weighted round-robin,
  3. # least connections, or least response time for better resource utilization and performance optimization.
  4. import asyncio
  5. import json
  6. import logging
  7. import os
  8. import random
  9. import re
  10. import time
  11. from datetime import datetime
  12. from typing import Optional, Union
  13. from urllib.parse import urlparse
  14. import aiohttp
  15. from aiocache import cached
  16. import requests
  17. from urllib.parse import quote
  18. from open_webui.models.chats import Chats
  19. from open_webui.models.users import UserModel
  20. from open_webui.env import (
  21. ENABLE_FORWARD_USER_INFO_HEADERS,
  22. )
  23. from fastapi import (
  24. Depends,
  25. FastAPI,
  26. File,
  27. HTTPException,
  28. Request,
  29. UploadFile,
  30. APIRouter,
  31. )
  32. from fastapi.middleware.cors import CORSMiddleware
  33. from fastapi.responses import StreamingResponse
  34. from pydantic import BaseModel, ConfigDict, validator
  35. from starlette.background import BackgroundTask
  36. from open_webui.models.models import Models
  37. from open_webui.utils.misc import (
  38. calculate_sha256,
  39. )
  40. from open_webui.utils.payload import (
  41. apply_model_params_to_body_ollama,
  42. apply_model_params_to_body_openai,
  43. apply_model_system_prompt_to_body,
  44. )
  45. from open_webui.utils.auth import get_admin_user, get_verified_user
  46. from open_webui.utils.access_control import has_access
  47. from open_webui.config import (
  48. UPLOAD_DIR,
  49. )
  50. from open_webui.env import (
  51. ENV,
  52. SRC_LOG_LEVELS,
  53. MODELS_CACHE_TTL,
  54. AIOHTTP_CLIENT_SESSION_SSL,
  55. AIOHTTP_CLIENT_TIMEOUT,
  56. AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST,
  57. BYPASS_MODEL_ACCESS_CONTROL,
  58. )
  59. from open_webui.constants import ERROR_MESSAGES
  60. log = logging.getLogger(__name__)
  61. log.setLevel(SRC_LOG_LEVELS["OLLAMA"])
  62. ##########################################
  63. #
  64. # Utility functions
  65. #
  66. ##########################################
  67. async def send_get_request(url, key=None, user: UserModel = None):
  68. timeout = aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST)
  69. try:
  70. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  71. async with session.get(
  72. url,
  73. headers={
  74. "Content-Type": "application/json",
  75. **({"Authorization": f"Bearer {key}"} if key else {}),
  76. **(
  77. {
  78. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  79. "X-OpenWebUI-User-Id": user.id,
  80. "X-OpenWebUI-User-Email": user.email,
  81. "X-OpenWebUI-User-Role": user.role,
  82. }
  83. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  84. else {}
  85. ),
  86. },
  87. ssl=AIOHTTP_CLIENT_SESSION_SSL,
  88. ) as response:
  89. return await response.json()
  90. except Exception as e:
  91. # Handle connection error here
  92. log.error(f"Connection error: {e}")
  93. return None
  94. async def cleanup_response(
  95. response: Optional[aiohttp.ClientResponse],
  96. session: Optional[aiohttp.ClientSession],
  97. ):
  98. if response:
  99. response.close()
  100. if session:
  101. await session.close()
  102. async def send_post_request(
  103. url: str,
  104. payload: Union[str, bytes],
  105. stream: bool = True,
  106. key: Optional[str] = None,
  107. content_type: Optional[str] = None,
  108. user: UserModel = None,
  109. ):
  110. r = None
  111. try:
  112. session = aiohttp.ClientSession(
  113. trust_env=True, timeout=aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT)
  114. )
  115. r = await session.post(
  116. url,
  117. data=payload,
  118. headers={
  119. "Content-Type": "application/json",
  120. **({"Authorization": f"Bearer {key}"} if key else {}),
  121. **(
  122. {
  123. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  124. "X-OpenWebUI-User-Id": user.id,
  125. "X-OpenWebUI-User-Email": user.email,
  126. "X-OpenWebUI-User-Role": user.role,
  127. }
  128. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  129. else {}
  130. ),
  131. },
  132. ssl=AIOHTTP_CLIENT_SESSION_SSL,
  133. )
  134. if r.ok is False:
  135. try:
  136. res = await r.json()
  137. await cleanup_response(r, session)
  138. if "error" in res:
  139. raise HTTPException(status_code=r.status, detail=res["error"])
  140. except HTTPException as e:
  141. raise e # Re-raise HTTPException to be handled by FastAPI
  142. except Exception as e:
  143. log.error(f"Failed to parse error response: {e}")
  144. raise HTTPException(
  145. status_code=r.status,
  146. detail=f"Open WebUI: Server Connection Error",
  147. )
  148. r.raise_for_status() # Raises an error for bad responses (4xx, 5xx)
  149. if stream:
  150. response_headers = dict(r.headers)
  151. if content_type:
  152. response_headers["Content-Type"] = content_type
  153. return StreamingResponse(
  154. r.content,
  155. status_code=r.status,
  156. headers=response_headers,
  157. background=BackgroundTask(
  158. cleanup_response, response=r, session=session
  159. ),
  160. )
  161. else:
  162. res = await r.json()
  163. return res
  164. except HTTPException as e:
  165. raise e # Re-raise HTTPException to be handled by FastAPI
  166. except Exception as e:
  167. detail = f"Ollama: {e}"
  168. raise HTTPException(
  169. status_code=r.status if r else 500,
  170. detail=detail if e else "Open WebUI: Server Connection Error",
  171. )
  172. finally:
  173. if not stream:
  174. await cleanup_response(r, session)
  175. def get_api_key(idx, url, configs):
  176. parsed_url = urlparse(url)
  177. base_url = f"{parsed_url.scheme}://{parsed_url.netloc}"
  178. return configs.get(str(idx), configs.get(base_url, {})).get(
  179. "key", None
  180. ) # Legacy support
  181. ##########################################
  182. #
  183. # API routes
  184. #
  185. ##########################################
  186. router = APIRouter()
  187. @router.head("/")
  188. @router.get("/")
  189. async def get_status():
  190. return {"status": True}
  191. class ConnectionVerificationForm(BaseModel):
  192. url: str
  193. key: Optional[str] = None
  194. @router.post("/verify")
  195. async def verify_connection(
  196. form_data: ConnectionVerificationForm, user=Depends(get_admin_user)
  197. ):
  198. url = form_data.url
  199. key = form_data.key
  200. async with aiohttp.ClientSession(
  201. trust_env=True,
  202. timeout=aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST),
  203. ) as session:
  204. try:
  205. async with session.get(
  206. f"{url}/api/version",
  207. headers={
  208. **({"Authorization": f"Bearer {key}"} if key else {}),
  209. **(
  210. {
  211. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  212. "X-OpenWebUI-User-Id": user.id,
  213. "X-OpenWebUI-User-Email": user.email,
  214. "X-OpenWebUI-User-Role": user.role,
  215. }
  216. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  217. else {}
  218. ),
  219. },
  220. ssl=AIOHTTP_CLIENT_SESSION_SSL,
  221. ) as r:
  222. if r.status != 200:
  223. detail = f"HTTP Error: {r.status}"
  224. res = await r.json()
  225. if "error" in res:
  226. detail = f"External Error: {res['error']}"
  227. raise Exception(detail)
  228. data = await r.json()
  229. return data
  230. except aiohttp.ClientError as e:
  231. log.exception(f"Client error: {str(e)}")
  232. raise HTTPException(
  233. status_code=500, detail="Open WebUI: Server Connection Error"
  234. )
  235. except Exception as e:
  236. log.exception(f"Unexpected error: {e}")
  237. error_detail = f"Unexpected error: {str(e)}"
  238. raise HTTPException(status_code=500, detail=error_detail)
  239. @router.get("/config")
  240. async def get_config(request: Request, user=Depends(get_admin_user)):
  241. return {
  242. "ENABLE_OLLAMA_API": request.app.state.config.ENABLE_OLLAMA_API,
  243. "OLLAMA_BASE_URLS": request.app.state.config.OLLAMA_BASE_URLS,
  244. "OLLAMA_API_CONFIGS": request.app.state.config.OLLAMA_API_CONFIGS,
  245. }
  246. class OllamaConfigForm(BaseModel):
  247. ENABLE_OLLAMA_API: Optional[bool] = None
  248. OLLAMA_BASE_URLS: list[str]
  249. OLLAMA_API_CONFIGS: dict
  250. @router.post("/config/update")
  251. async def update_config(
  252. request: Request, form_data: OllamaConfigForm, user=Depends(get_admin_user)
  253. ):
  254. request.app.state.config.ENABLE_OLLAMA_API = form_data.ENABLE_OLLAMA_API
  255. request.app.state.config.OLLAMA_BASE_URLS = form_data.OLLAMA_BASE_URLS
  256. request.app.state.config.OLLAMA_API_CONFIGS = form_data.OLLAMA_API_CONFIGS
  257. # Remove the API configs that are not in the API URLS
  258. keys = list(map(str, range(len(request.app.state.config.OLLAMA_BASE_URLS))))
  259. request.app.state.config.OLLAMA_API_CONFIGS = {
  260. key: value
  261. for key, value in request.app.state.config.OLLAMA_API_CONFIGS.items()
  262. if key in keys
  263. }
  264. return {
  265. "ENABLE_OLLAMA_API": request.app.state.config.ENABLE_OLLAMA_API,
  266. "OLLAMA_BASE_URLS": request.app.state.config.OLLAMA_BASE_URLS,
  267. "OLLAMA_API_CONFIGS": request.app.state.config.OLLAMA_API_CONFIGS,
  268. }
  269. def merge_ollama_models_lists(model_lists):
  270. merged_models = {}
  271. for idx, model_list in enumerate(model_lists):
  272. if model_list is not None:
  273. for model in model_list:
  274. id = model["model"]
  275. if id not in merged_models:
  276. model["urls"] = [idx]
  277. merged_models[id] = model
  278. else:
  279. merged_models[id]["urls"].append(idx)
  280. return list(merged_models.values())
  281. @cached(ttl=MODELS_CACHE_TTL)
  282. async def get_all_models(request: Request, user: UserModel = None):
  283. log.info("get_all_models()")
  284. if request.app.state.config.ENABLE_OLLAMA_API:
  285. request_tasks = []
  286. for idx, url in enumerate(request.app.state.config.OLLAMA_BASE_URLS):
  287. if (str(idx) not in request.app.state.config.OLLAMA_API_CONFIGS) and (
  288. url not in request.app.state.config.OLLAMA_API_CONFIGS # Legacy support
  289. ):
  290. request_tasks.append(send_get_request(f"{url}/api/tags", user=user))
  291. else:
  292. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  293. str(idx),
  294. request.app.state.config.OLLAMA_API_CONFIGS.get(
  295. url, {}
  296. ), # Legacy support
  297. )
  298. enable = api_config.get("enable", True)
  299. key = api_config.get("key", None)
  300. if enable:
  301. request_tasks.append(
  302. send_get_request(f"{url}/api/tags", key, user=user)
  303. )
  304. else:
  305. request_tasks.append(asyncio.ensure_future(asyncio.sleep(0, None)))
  306. responses = await asyncio.gather(*request_tasks)
  307. for idx, response in enumerate(responses):
  308. if response:
  309. url = request.app.state.config.OLLAMA_BASE_URLS[idx]
  310. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  311. str(idx),
  312. request.app.state.config.OLLAMA_API_CONFIGS.get(
  313. url, {}
  314. ), # Legacy support
  315. )
  316. connection_type = api_config.get("connection_type", "local")
  317. prefix_id = api_config.get("prefix_id", None)
  318. tags = api_config.get("tags", [])
  319. model_ids = api_config.get("model_ids", [])
  320. if len(model_ids) != 0 and "models" in response:
  321. response["models"] = list(
  322. filter(
  323. lambda model: model["model"] in model_ids,
  324. response["models"],
  325. )
  326. )
  327. for model in response.get("models", []):
  328. if prefix_id:
  329. model["model"] = f"{prefix_id}.{model['model']}"
  330. if tags:
  331. model["tags"] = tags
  332. if connection_type:
  333. model["connection_type"] = connection_type
  334. models = {
  335. "models": merge_ollama_models_lists(
  336. map(
  337. lambda response: response.get("models", []) if response else None,
  338. responses,
  339. )
  340. )
  341. }
  342. try:
  343. loaded_models = await get_ollama_loaded_models(request, user=user)
  344. expires_map = {
  345. m["name"]: m["expires_at"]
  346. for m in loaded_models["models"]
  347. if "expires_at" in m
  348. }
  349. for m in models["models"]:
  350. if m["name"] in expires_map:
  351. # Parse ISO8601 datetime with offset, get unix timestamp as int
  352. dt = datetime.fromisoformat(expires_map[m["name"]])
  353. m["expires_at"] = int(dt.timestamp())
  354. except Exception as e:
  355. log.debug(f"Failed to get loaded models: {e}")
  356. else:
  357. models = {"models": []}
  358. request.app.state.OLLAMA_MODELS = {
  359. model["model"]: model for model in models["models"]
  360. }
  361. return models
  362. async def get_filtered_models(models, user):
  363. # Filter models based on user access control
  364. filtered_models = []
  365. for model in models.get("models", []):
  366. model_info = Models.get_model_by_id(model["model"])
  367. if model_info:
  368. if user.id == model_info.user_id or has_access(
  369. user.id, type="read", access_control=model_info.access_control
  370. ):
  371. filtered_models.append(model)
  372. return filtered_models
  373. @router.get("/api/tags")
  374. @router.get("/api/tags/{url_idx}")
  375. async def get_ollama_tags(
  376. request: Request, url_idx: Optional[int] = None, user=Depends(get_verified_user)
  377. ):
  378. models = []
  379. if url_idx is None:
  380. models = await get_all_models(request, user=user)
  381. else:
  382. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  383. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  384. r = None
  385. try:
  386. r = requests.request(
  387. method="GET",
  388. url=f"{url}/api/tags",
  389. headers={
  390. **({"Authorization": f"Bearer {key}"} if key else {}),
  391. **(
  392. {
  393. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  394. "X-OpenWebUI-User-Id": user.id,
  395. "X-OpenWebUI-User-Email": user.email,
  396. "X-OpenWebUI-User-Role": user.role,
  397. }
  398. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  399. else {}
  400. ),
  401. },
  402. )
  403. r.raise_for_status()
  404. models = r.json()
  405. except Exception as e:
  406. log.exception(e)
  407. detail = None
  408. if r is not None:
  409. try:
  410. res = r.json()
  411. if "error" in res:
  412. detail = f"Ollama: {res['error']}"
  413. except Exception:
  414. detail = f"Ollama: {e}"
  415. raise HTTPException(
  416. status_code=r.status_code if r else 500,
  417. detail=detail if detail else "Open WebUI: Server Connection Error",
  418. )
  419. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  420. models["models"] = await get_filtered_models(models, user)
  421. return models
  422. @router.get("/api/ps")
  423. async def get_ollama_loaded_models(request: Request, user=Depends(get_admin_user)):
  424. """
  425. List models that are currently loaded into Ollama memory, and which node they are loaded on.
  426. """
  427. if request.app.state.config.ENABLE_OLLAMA_API:
  428. request_tasks = []
  429. for idx, url in enumerate(request.app.state.config.OLLAMA_BASE_URLS):
  430. if (str(idx) not in request.app.state.config.OLLAMA_API_CONFIGS) and (
  431. url not in request.app.state.config.OLLAMA_API_CONFIGS # Legacy support
  432. ):
  433. request_tasks.append(send_get_request(f"{url}/api/ps", user=user))
  434. else:
  435. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  436. str(idx),
  437. request.app.state.config.OLLAMA_API_CONFIGS.get(
  438. url, {}
  439. ), # Legacy support
  440. )
  441. enable = api_config.get("enable", True)
  442. key = api_config.get("key", None)
  443. if enable:
  444. request_tasks.append(
  445. send_get_request(f"{url}/api/ps", key, user=user)
  446. )
  447. else:
  448. request_tasks.append(asyncio.ensure_future(asyncio.sleep(0, None)))
  449. responses = await asyncio.gather(*request_tasks)
  450. for idx, response in enumerate(responses):
  451. if response:
  452. url = request.app.state.config.OLLAMA_BASE_URLS[idx]
  453. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  454. str(idx),
  455. request.app.state.config.OLLAMA_API_CONFIGS.get(
  456. url, {}
  457. ), # Legacy support
  458. )
  459. prefix_id = api_config.get("prefix_id", None)
  460. for model in response.get("models", []):
  461. if prefix_id:
  462. model["model"] = f"{prefix_id}.{model['model']}"
  463. models = {
  464. "models": merge_ollama_models_lists(
  465. map(
  466. lambda response: response.get("models", []) if response else None,
  467. responses,
  468. )
  469. )
  470. }
  471. else:
  472. models = {"models": []}
  473. return models
  474. @router.get("/api/version")
  475. @router.get("/api/version/{url_idx}")
  476. async def get_ollama_versions(request: Request, url_idx: Optional[int] = None):
  477. if request.app.state.config.ENABLE_OLLAMA_API:
  478. if url_idx is None:
  479. # returns lowest version
  480. request_tasks = []
  481. for idx, url in enumerate(request.app.state.config.OLLAMA_BASE_URLS):
  482. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  483. str(idx),
  484. request.app.state.config.OLLAMA_API_CONFIGS.get(
  485. url, {}
  486. ), # Legacy support
  487. )
  488. enable = api_config.get("enable", True)
  489. key = api_config.get("key", None)
  490. if enable:
  491. request_tasks.append(
  492. send_get_request(
  493. f"{url}/api/version",
  494. key,
  495. )
  496. )
  497. responses = await asyncio.gather(*request_tasks)
  498. responses = list(filter(lambda x: x is not None, responses))
  499. if len(responses) > 0:
  500. lowest_version = min(
  501. responses,
  502. key=lambda x: tuple(
  503. map(int, re.sub(r"^v|-.*", "", x["version"]).split("."))
  504. ),
  505. )
  506. return {"version": lowest_version["version"]}
  507. else:
  508. raise HTTPException(
  509. status_code=500,
  510. detail=ERROR_MESSAGES.OLLAMA_NOT_FOUND,
  511. )
  512. else:
  513. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  514. r = None
  515. try:
  516. r = requests.request(method="GET", url=f"{url}/api/version")
  517. r.raise_for_status()
  518. return r.json()
  519. except Exception as e:
  520. log.exception(e)
  521. detail = None
  522. if r is not None:
  523. try:
  524. res = r.json()
  525. if "error" in res:
  526. detail = f"Ollama: {res['error']}"
  527. except Exception:
  528. detail = f"Ollama: {e}"
  529. raise HTTPException(
  530. status_code=r.status_code if r else 500,
  531. detail=detail if detail else "Open WebUI: Server Connection Error",
  532. )
  533. else:
  534. return {"version": False}
  535. class ModelNameForm(BaseModel):
  536. model: Optional[str] = None
  537. model_config = ConfigDict(
  538. extra="allow",
  539. )
  540. @router.post("/api/unload")
  541. async def unload_model(
  542. request: Request,
  543. form_data: ModelNameForm,
  544. user=Depends(get_admin_user),
  545. ):
  546. form_data = form_data.model_dump(exclude_none=True)
  547. model_name = form_data.get("model", form_data.get("name"))
  548. if not model_name:
  549. raise HTTPException(
  550. status_code=400, detail="Missing name of the model to unload."
  551. )
  552. # Refresh/load models if needed, get mapping from name to URLs
  553. await get_all_models(request, user=user)
  554. models = request.app.state.OLLAMA_MODELS
  555. # Canonicalize model name (if not supplied with version)
  556. if ":" not in model_name:
  557. model_name = f"{model_name}:latest"
  558. if model_name not in models:
  559. raise HTTPException(
  560. status_code=400, detail=ERROR_MESSAGES.MODEL_NOT_FOUND(model_name)
  561. )
  562. url_indices = models[model_name]["urls"]
  563. # Send unload to ALL url_indices
  564. results = []
  565. errors = []
  566. for idx in url_indices:
  567. url = request.app.state.config.OLLAMA_BASE_URLS[idx]
  568. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  569. str(idx), request.app.state.config.OLLAMA_API_CONFIGS.get(url, {})
  570. )
  571. key = get_api_key(idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  572. prefix_id = api_config.get("prefix_id", None)
  573. if prefix_id and model_name.startswith(f"{prefix_id}."):
  574. model_name = model_name[len(f"{prefix_id}.") :]
  575. payload = {"model": model_name, "keep_alive": 0, "prompt": ""}
  576. try:
  577. res = await send_post_request(
  578. url=f"{url}/api/generate",
  579. payload=json.dumps(payload),
  580. stream=False,
  581. key=key,
  582. user=user,
  583. )
  584. results.append({"url_idx": idx, "success": True, "response": res})
  585. except Exception as e:
  586. log.exception(f"Failed to unload model on node {idx}: {e}")
  587. errors.append({"url_idx": idx, "success": False, "error": str(e)})
  588. if len(errors) > 0:
  589. raise HTTPException(
  590. status_code=500,
  591. detail=f"Failed to unload model on {len(errors)} nodes: {errors}",
  592. )
  593. return {"status": True}
  594. @router.post("/api/pull")
  595. @router.post("/api/pull/{url_idx}")
  596. async def pull_model(
  597. request: Request,
  598. form_data: ModelNameForm,
  599. url_idx: int = 0,
  600. user=Depends(get_admin_user),
  601. ):
  602. form_data = form_data.model_dump(exclude_none=True)
  603. form_data["model"] = form_data.get("model", form_data.get("name"))
  604. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  605. log.info(f"url: {url}")
  606. # Admin should be able to pull models from any source
  607. payload = {**form_data, "insecure": True}
  608. return await send_post_request(
  609. url=f"{url}/api/pull",
  610. payload=json.dumps(payload),
  611. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  612. user=user,
  613. )
  614. class PushModelForm(BaseModel):
  615. model: str
  616. insecure: Optional[bool] = None
  617. stream: Optional[bool] = None
  618. @router.delete("/api/push")
  619. @router.delete("/api/push/{url_idx}")
  620. async def push_model(
  621. request: Request,
  622. form_data: PushModelForm,
  623. url_idx: Optional[int] = None,
  624. user=Depends(get_admin_user),
  625. ):
  626. if url_idx is None:
  627. await get_all_models(request, user=user)
  628. models = request.app.state.OLLAMA_MODELS
  629. if form_data.model in models:
  630. url_idx = models[form_data.model]["urls"][0]
  631. else:
  632. raise HTTPException(
  633. status_code=400,
  634. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  635. )
  636. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  637. log.debug(f"url: {url}")
  638. return await send_post_request(
  639. url=f"{url}/api/push",
  640. payload=form_data.model_dump_json(exclude_none=True).encode(),
  641. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  642. user=user,
  643. )
  644. class CreateModelForm(BaseModel):
  645. model: Optional[str] = None
  646. stream: Optional[bool] = None
  647. path: Optional[str] = None
  648. model_config = ConfigDict(extra="allow")
  649. @router.post("/api/create")
  650. @router.post("/api/create/{url_idx}")
  651. async def create_model(
  652. request: Request,
  653. form_data: CreateModelForm,
  654. url_idx: int = 0,
  655. user=Depends(get_admin_user),
  656. ):
  657. log.debug(f"form_data: {form_data}")
  658. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  659. return await send_post_request(
  660. url=f"{url}/api/create",
  661. payload=form_data.model_dump_json(exclude_none=True).encode(),
  662. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  663. user=user,
  664. )
  665. class CopyModelForm(BaseModel):
  666. source: str
  667. destination: str
  668. @router.post("/api/copy")
  669. @router.post("/api/copy/{url_idx}")
  670. async def copy_model(
  671. request: Request,
  672. form_data: CopyModelForm,
  673. url_idx: Optional[int] = None,
  674. user=Depends(get_admin_user),
  675. ):
  676. if url_idx is None:
  677. await get_all_models(request, user=user)
  678. models = request.app.state.OLLAMA_MODELS
  679. if form_data.source in models:
  680. url_idx = models[form_data.source]["urls"][0]
  681. else:
  682. raise HTTPException(
  683. status_code=400,
  684. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
  685. )
  686. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  687. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  688. try:
  689. r = requests.request(
  690. method="POST",
  691. url=f"{url}/api/copy",
  692. headers={
  693. "Content-Type": "application/json",
  694. **({"Authorization": f"Bearer {key}"} if key else {}),
  695. **(
  696. {
  697. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  698. "X-OpenWebUI-User-Id": user.id,
  699. "X-OpenWebUI-User-Email": user.email,
  700. "X-OpenWebUI-User-Role": user.role,
  701. }
  702. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  703. else {}
  704. ),
  705. },
  706. data=form_data.model_dump_json(exclude_none=True).encode(),
  707. )
  708. r.raise_for_status()
  709. log.debug(f"r.text: {r.text}")
  710. return True
  711. except Exception as e:
  712. log.exception(e)
  713. detail = None
  714. if r is not None:
  715. try:
  716. res = r.json()
  717. if "error" in res:
  718. detail = f"Ollama: {res['error']}"
  719. except Exception:
  720. detail = f"Ollama: {e}"
  721. raise HTTPException(
  722. status_code=r.status_code if r else 500,
  723. detail=detail if detail else "Open WebUI: Server Connection Error",
  724. )
  725. @router.delete("/api/delete")
  726. @router.delete("/api/delete/{url_idx}")
  727. async def delete_model(
  728. request: Request,
  729. form_data: ModelNameForm,
  730. url_idx: Optional[int] = None,
  731. user=Depends(get_admin_user),
  732. ):
  733. form_data = form_data.model_dump(exclude_none=True)
  734. form_data["model"] = form_data.get("model", form_data.get("name"))
  735. model = form_data.get("model")
  736. if url_idx is None:
  737. await get_all_models(request, user=user)
  738. models = request.app.state.OLLAMA_MODELS
  739. if model in models:
  740. url_idx = models[model]["urls"][0]
  741. else:
  742. raise HTTPException(
  743. status_code=400,
  744. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(model),
  745. )
  746. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  747. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  748. try:
  749. r = requests.request(
  750. method="DELETE",
  751. url=f"{url}/api/delete",
  752. data=json.dumps(form_data).encode(),
  753. headers={
  754. "Content-Type": "application/json",
  755. **({"Authorization": f"Bearer {key}"} if key else {}),
  756. **(
  757. {
  758. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  759. "X-OpenWebUI-User-Id": user.id,
  760. "X-OpenWebUI-User-Email": user.email,
  761. "X-OpenWebUI-User-Role": user.role,
  762. }
  763. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  764. else {}
  765. ),
  766. },
  767. )
  768. r.raise_for_status()
  769. log.debug(f"r.text: {r.text}")
  770. return True
  771. except Exception as e:
  772. log.exception(e)
  773. detail = None
  774. if r is not None:
  775. try:
  776. res = r.json()
  777. if "error" in res:
  778. detail = f"Ollama: {res['error']}"
  779. except Exception:
  780. detail = f"Ollama: {e}"
  781. raise HTTPException(
  782. status_code=r.status_code if r else 500,
  783. detail=detail if detail else "Open WebUI: Server Connection Error",
  784. )
  785. @router.post("/api/show")
  786. async def show_model_info(
  787. request: Request, form_data: ModelNameForm, user=Depends(get_verified_user)
  788. ):
  789. form_data = form_data.model_dump(exclude_none=True)
  790. form_data["model"] = form_data.get("model", form_data.get("name"))
  791. await get_all_models(request, user=user)
  792. models = request.app.state.OLLAMA_MODELS
  793. model = form_data.get("model")
  794. if model not in models:
  795. raise HTTPException(
  796. status_code=400,
  797. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(model),
  798. )
  799. url_idx = random.choice(models[model]["urls"])
  800. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  801. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  802. try:
  803. r = requests.request(
  804. method="POST",
  805. url=f"{url}/api/show",
  806. headers={
  807. "Content-Type": "application/json",
  808. **({"Authorization": f"Bearer {key}"} if key else {}),
  809. **(
  810. {
  811. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  812. "X-OpenWebUI-User-Id": user.id,
  813. "X-OpenWebUI-User-Email": user.email,
  814. "X-OpenWebUI-User-Role": user.role,
  815. }
  816. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  817. else {}
  818. ),
  819. },
  820. data=json.dumps(form_data).encode(),
  821. )
  822. r.raise_for_status()
  823. return r.json()
  824. except Exception as e:
  825. log.exception(e)
  826. detail = None
  827. if r is not None:
  828. try:
  829. res = r.json()
  830. if "error" in res:
  831. detail = f"Ollama: {res['error']}"
  832. except Exception:
  833. detail = f"Ollama: {e}"
  834. raise HTTPException(
  835. status_code=r.status_code if r else 500,
  836. detail=detail if detail else "Open WebUI: Server Connection Error",
  837. )
  838. class GenerateEmbedForm(BaseModel):
  839. model: str
  840. input: list[str] | str
  841. truncate: Optional[bool] = None
  842. options: Optional[dict] = None
  843. keep_alive: Optional[Union[int, str]] = None
  844. @router.post("/api/embed")
  845. @router.post("/api/embed/{url_idx}")
  846. async def embed(
  847. request: Request,
  848. form_data: GenerateEmbedForm,
  849. url_idx: Optional[int] = None,
  850. user=Depends(get_verified_user),
  851. ):
  852. log.info(f"generate_ollama_batch_embeddings {form_data}")
  853. if url_idx is None:
  854. await get_all_models(request, user=user)
  855. models = request.app.state.OLLAMA_MODELS
  856. model = form_data.model
  857. if ":" not in model:
  858. model = f"{model}:latest"
  859. if model in models:
  860. url_idx = random.choice(models[model]["urls"])
  861. else:
  862. raise HTTPException(
  863. status_code=400,
  864. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  865. )
  866. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  867. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  868. str(url_idx),
  869. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  870. )
  871. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  872. prefix_id = api_config.get("prefix_id", None)
  873. if prefix_id:
  874. form_data.model = form_data.model.replace(f"{prefix_id}.", "")
  875. try:
  876. r = requests.request(
  877. method="POST",
  878. url=f"{url}/api/embed",
  879. headers={
  880. "Content-Type": "application/json",
  881. **({"Authorization": f"Bearer {key}"} if key else {}),
  882. **(
  883. {
  884. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  885. "X-OpenWebUI-User-Id": user.id,
  886. "X-OpenWebUI-User-Email": user.email,
  887. "X-OpenWebUI-User-Role": user.role,
  888. }
  889. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  890. else {}
  891. ),
  892. },
  893. data=form_data.model_dump_json(exclude_none=True).encode(),
  894. )
  895. r.raise_for_status()
  896. data = r.json()
  897. return data
  898. except Exception as e:
  899. log.exception(e)
  900. detail = None
  901. if r is not None:
  902. try:
  903. res = r.json()
  904. if "error" in res:
  905. detail = f"Ollama: {res['error']}"
  906. except Exception:
  907. detail = f"Ollama: {e}"
  908. raise HTTPException(
  909. status_code=r.status_code if r else 500,
  910. detail=detail if detail else "Open WebUI: Server Connection Error",
  911. )
  912. class GenerateEmbeddingsForm(BaseModel):
  913. model: str
  914. prompt: str
  915. options: Optional[dict] = None
  916. keep_alive: Optional[Union[int, str]] = None
  917. @router.post("/api/embeddings")
  918. @router.post("/api/embeddings/{url_idx}")
  919. async def embeddings(
  920. request: Request,
  921. form_data: GenerateEmbeddingsForm,
  922. url_idx: Optional[int] = None,
  923. user=Depends(get_verified_user),
  924. ):
  925. log.info(f"generate_ollama_embeddings {form_data}")
  926. if url_idx is None:
  927. await get_all_models(request, user=user)
  928. models = request.app.state.OLLAMA_MODELS
  929. model = form_data.model
  930. if ":" not in model:
  931. model = f"{model}:latest"
  932. if model in models:
  933. url_idx = random.choice(models[model]["urls"])
  934. else:
  935. raise HTTPException(
  936. status_code=400,
  937. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  938. )
  939. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  940. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  941. str(url_idx),
  942. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  943. )
  944. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  945. prefix_id = api_config.get("prefix_id", None)
  946. if prefix_id:
  947. form_data.model = form_data.model.replace(f"{prefix_id}.", "")
  948. try:
  949. r = requests.request(
  950. method="POST",
  951. url=f"{url}/api/embeddings",
  952. headers={
  953. "Content-Type": "application/json",
  954. **({"Authorization": f"Bearer {key}"} if key else {}),
  955. **(
  956. {
  957. "X-OpenWebUI-User-Name": quote(user.name, safe=" "),
  958. "X-OpenWebUI-User-Id": user.id,
  959. "X-OpenWebUI-User-Email": user.email,
  960. "X-OpenWebUI-User-Role": user.role,
  961. }
  962. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  963. else {}
  964. ),
  965. },
  966. data=form_data.model_dump_json(exclude_none=True).encode(),
  967. )
  968. r.raise_for_status()
  969. data = r.json()
  970. return data
  971. except Exception as e:
  972. log.exception(e)
  973. detail = None
  974. if r is not None:
  975. try:
  976. res = r.json()
  977. if "error" in res:
  978. detail = f"Ollama: {res['error']}"
  979. except Exception:
  980. detail = f"Ollama: {e}"
  981. raise HTTPException(
  982. status_code=r.status_code if r else 500,
  983. detail=detail if detail else "Open WebUI: Server Connection Error",
  984. )
  985. class GenerateCompletionForm(BaseModel):
  986. model: str
  987. prompt: str
  988. suffix: Optional[str] = None
  989. images: Optional[list[str]] = None
  990. format: Optional[Union[dict, str]] = None
  991. options: Optional[dict] = None
  992. system: Optional[str] = None
  993. template: Optional[str] = None
  994. context: Optional[list[int]] = None
  995. stream: Optional[bool] = True
  996. raw: Optional[bool] = None
  997. keep_alive: Optional[Union[int, str]] = None
  998. @router.post("/api/generate")
  999. @router.post("/api/generate/{url_idx}")
  1000. async def generate_completion(
  1001. request: Request,
  1002. form_data: GenerateCompletionForm,
  1003. url_idx: Optional[int] = None,
  1004. user=Depends(get_verified_user),
  1005. ):
  1006. if url_idx is None:
  1007. await get_all_models(request, user=user)
  1008. models = request.app.state.OLLAMA_MODELS
  1009. model = form_data.model
  1010. if ":" not in model:
  1011. model = f"{model}:latest"
  1012. if model in models:
  1013. url_idx = random.choice(models[model]["urls"])
  1014. else:
  1015. raise HTTPException(
  1016. status_code=400,
  1017. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  1018. )
  1019. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1020. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  1021. str(url_idx),
  1022. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  1023. )
  1024. prefix_id = api_config.get("prefix_id", None)
  1025. if prefix_id:
  1026. form_data.model = form_data.model.replace(f"{prefix_id}.", "")
  1027. return await send_post_request(
  1028. url=f"{url}/api/generate",
  1029. payload=form_data.model_dump_json(exclude_none=True).encode(),
  1030. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  1031. user=user,
  1032. )
  1033. class ChatMessage(BaseModel):
  1034. role: str
  1035. content: Optional[str] = None
  1036. tool_calls: Optional[list[dict]] = None
  1037. images: Optional[list[str]] = None
  1038. @validator("content", pre=True)
  1039. @classmethod
  1040. def check_at_least_one_field(cls, field_value, values, **kwargs):
  1041. # Raise an error if both 'content' and 'tool_calls' are None
  1042. if field_value is None and (
  1043. "tool_calls" not in values or values["tool_calls"] is None
  1044. ):
  1045. raise ValueError(
  1046. "At least one of 'content' or 'tool_calls' must be provided"
  1047. )
  1048. return field_value
  1049. class GenerateChatCompletionForm(BaseModel):
  1050. model: str
  1051. messages: list[ChatMessage]
  1052. format: Optional[Union[dict, str]] = None
  1053. options: Optional[dict] = None
  1054. template: Optional[str] = None
  1055. stream: Optional[bool] = True
  1056. keep_alive: Optional[Union[int, str]] = None
  1057. tools: Optional[list[dict]] = None
  1058. model_config = ConfigDict(
  1059. extra="allow",
  1060. )
  1061. async def get_ollama_url(request: Request, model: str, url_idx: Optional[int] = None):
  1062. if url_idx is None:
  1063. models = request.app.state.OLLAMA_MODELS
  1064. if model not in models:
  1065. raise HTTPException(
  1066. status_code=400,
  1067. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(model),
  1068. )
  1069. url_idx = random.choice(models[model].get("urls", []))
  1070. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1071. return url, url_idx
  1072. @router.post("/api/chat")
  1073. @router.post("/api/chat/{url_idx}")
  1074. async def generate_chat_completion(
  1075. request: Request,
  1076. form_data: dict,
  1077. url_idx: Optional[int] = None,
  1078. user=Depends(get_verified_user),
  1079. bypass_filter: Optional[bool] = False,
  1080. ):
  1081. if BYPASS_MODEL_ACCESS_CONTROL:
  1082. bypass_filter = True
  1083. metadata = form_data.pop("metadata", None)
  1084. try:
  1085. form_data = GenerateChatCompletionForm(**form_data)
  1086. except Exception as e:
  1087. log.exception(e)
  1088. raise HTTPException(
  1089. status_code=400,
  1090. detail=str(e),
  1091. )
  1092. if isinstance(form_data, BaseModel):
  1093. payload = {**form_data.model_dump(exclude_none=True)}
  1094. if "metadata" in payload:
  1095. del payload["metadata"]
  1096. model_id = payload["model"]
  1097. model_info = Models.get_model_by_id(model_id)
  1098. if model_info:
  1099. if model_info.base_model_id:
  1100. payload["model"] = model_info.base_model_id
  1101. params = model_info.params.model_dump()
  1102. if params:
  1103. system = params.pop("system", None)
  1104. payload = apply_model_params_to_body_ollama(params, payload)
  1105. payload = apply_model_system_prompt_to_body(system, payload, metadata, user)
  1106. # Check if user has access to the model
  1107. if not bypass_filter and user.role == "user":
  1108. if not (
  1109. user.id == model_info.user_id
  1110. or has_access(
  1111. user.id, type="read", access_control=model_info.access_control
  1112. )
  1113. ):
  1114. raise HTTPException(
  1115. status_code=403,
  1116. detail="Model not found",
  1117. )
  1118. elif not bypass_filter:
  1119. if user.role != "admin":
  1120. raise HTTPException(
  1121. status_code=403,
  1122. detail="Model not found",
  1123. )
  1124. if ":" not in payload["model"]:
  1125. payload["model"] = f"{payload['model']}:latest"
  1126. url, url_idx = await get_ollama_url(request, payload["model"], url_idx)
  1127. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  1128. str(url_idx),
  1129. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  1130. )
  1131. prefix_id = api_config.get("prefix_id", None)
  1132. if prefix_id:
  1133. payload["model"] = payload["model"].replace(f"{prefix_id}.", "")
  1134. return await send_post_request(
  1135. url=f"{url}/api/chat",
  1136. payload=json.dumps(payload),
  1137. stream=form_data.stream,
  1138. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  1139. content_type="application/x-ndjson",
  1140. user=user,
  1141. )
  1142. # TODO: we should update this part once Ollama supports other types
  1143. class OpenAIChatMessageContent(BaseModel):
  1144. type: str
  1145. model_config = ConfigDict(extra="allow")
  1146. class OpenAIChatMessage(BaseModel):
  1147. role: str
  1148. content: Union[Optional[str], list[OpenAIChatMessageContent]]
  1149. model_config = ConfigDict(extra="allow")
  1150. class OpenAIChatCompletionForm(BaseModel):
  1151. model: str
  1152. messages: list[OpenAIChatMessage]
  1153. model_config = ConfigDict(extra="allow")
  1154. class OpenAICompletionForm(BaseModel):
  1155. model: str
  1156. prompt: str
  1157. model_config = ConfigDict(extra="allow")
  1158. @router.post("/v1/completions")
  1159. @router.post("/v1/completions/{url_idx}")
  1160. async def generate_openai_completion(
  1161. request: Request,
  1162. form_data: dict,
  1163. url_idx: Optional[int] = None,
  1164. user=Depends(get_verified_user),
  1165. ):
  1166. try:
  1167. form_data = OpenAICompletionForm(**form_data)
  1168. except Exception as e:
  1169. log.exception(e)
  1170. raise HTTPException(
  1171. status_code=400,
  1172. detail=str(e),
  1173. )
  1174. payload = {**form_data.model_dump(exclude_none=True, exclude=["metadata"])}
  1175. if "metadata" in payload:
  1176. del payload["metadata"]
  1177. model_id = form_data.model
  1178. if ":" not in model_id:
  1179. model_id = f"{model_id}:latest"
  1180. model_info = Models.get_model_by_id(model_id)
  1181. if model_info:
  1182. if model_info.base_model_id:
  1183. payload["model"] = model_info.base_model_id
  1184. params = model_info.params.model_dump()
  1185. if params:
  1186. payload = apply_model_params_to_body_openai(params, payload)
  1187. # Check if user has access to the model
  1188. if user.role == "user":
  1189. if not (
  1190. user.id == model_info.user_id
  1191. or has_access(
  1192. user.id, type="read", access_control=model_info.access_control
  1193. )
  1194. ):
  1195. raise HTTPException(
  1196. status_code=403,
  1197. detail="Model not found",
  1198. )
  1199. else:
  1200. if user.role != "admin":
  1201. raise HTTPException(
  1202. status_code=403,
  1203. detail="Model not found",
  1204. )
  1205. if ":" not in payload["model"]:
  1206. payload["model"] = f"{payload['model']}:latest"
  1207. url, url_idx = await get_ollama_url(request, payload["model"], url_idx)
  1208. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  1209. str(url_idx),
  1210. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  1211. )
  1212. prefix_id = api_config.get("prefix_id", None)
  1213. if prefix_id:
  1214. payload["model"] = payload["model"].replace(f"{prefix_id}.", "")
  1215. return await send_post_request(
  1216. url=f"{url}/v1/completions",
  1217. payload=json.dumps(payload),
  1218. stream=payload.get("stream", False),
  1219. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  1220. user=user,
  1221. )
  1222. @router.post("/v1/chat/completions")
  1223. @router.post("/v1/chat/completions/{url_idx}")
  1224. async def generate_openai_chat_completion(
  1225. request: Request,
  1226. form_data: dict,
  1227. url_idx: Optional[int] = None,
  1228. user=Depends(get_verified_user),
  1229. ):
  1230. metadata = form_data.pop("metadata", None)
  1231. try:
  1232. completion_form = OpenAIChatCompletionForm(**form_data)
  1233. except Exception as e:
  1234. log.exception(e)
  1235. raise HTTPException(
  1236. status_code=400,
  1237. detail=str(e),
  1238. )
  1239. payload = {**completion_form.model_dump(exclude_none=True, exclude=["metadata"])}
  1240. if "metadata" in payload:
  1241. del payload["metadata"]
  1242. model_id = completion_form.model
  1243. if ":" not in model_id:
  1244. model_id = f"{model_id}:latest"
  1245. model_info = Models.get_model_by_id(model_id)
  1246. if model_info:
  1247. if model_info.base_model_id:
  1248. payload["model"] = model_info.base_model_id
  1249. params = model_info.params.model_dump()
  1250. if params:
  1251. system = params.pop("system", None)
  1252. payload = apply_model_params_to_body_openai(params, payload)
  1253. payload = apply_model_system_prompt_to_body(system, payload, metadata, user)
  1254. # Check if user has access to the model
  1255. if user.role == "user":
  1256. if not (
  1257. user.id == model_info.user_id
  1258. or has_access(
  1259. user.id, type="read", access_control=model_info.access_control
  1260. )
  1261. ):
  1262. raise HTTPException(
  1263. status_code=403,
  1264. detail="Model not found",
  1265. )
  1266. else:
  1267. if user.role != "admin":
  1268. raise HTTPException(
  1269. status_code=403,
  1270. detail="Model not found",
  1271. )
  1272. if ":" not in payload["model"]:
  1273. payload["model"] = f"{payload['model']}:latest"
  1274. url, url_idx = await get_ollama_url(request, payload["model"], url_idx)
  1275. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  1276. str(url_idx),
  1277. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  1278. )
  1279. prefix_id = api_config.get("prefix_id", None)
  1280. if prefix_id:
  1281. payload["model"] = payload["model"].replace(f"{prefix_id}.", "")
  1282. return await send_post_request(
  1283. url=f"{url}/v1/chat/completions",
  1284. payload=json.dumps(payload),
  1285. stream=payload.get("stream", False),
  1286. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  1287. user=user,
  1288. )
  1289. @router.get("/v1/models")
  1290. @router.get("/v1/models/{url_idx}")
  1291. async def get_openai_models(
  1292. request: Request,
  1293. url_idx: Optional[int] = None,
  1294. user=Depends(get_verified_user),
  1295. ):
  1296. models = []
  1297. if url_idx is None:
  1298. model_list = await get_all_models(request, user=user)
  1299. models = [
  1300. {
  1301. "id": model["model"],
  1302. "object": "model",
  1303. "created": int(time.time()),
  1304. "owned_by": "openai",
  1305. }
  1306. for model in model_list["models"]
  1307. ]
  1308. else:
  1309. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1310. try:
  1311. r = requests.request(method="GET", url=f"{url}/api/tags")
  1312. r.raise_for_status()
  1313. model_list = r.json()
  1314. models = [
  1315. {
  1316. "id": model["model"],
  1317. "object": "model",
  1318. "created": int(time.time()),
  1319. "owned_by": "openai",
  1320. }
  1321. for model in models["models"]
  1322. ]
  1323. except Exception as e:
  1324. log.exception(e)
  1325. error_detail = "Open WebUI: Server Connection Error"
  1326. if r is not None:
  1327. try:
  1328. res = r.json()
  1329. if "error" in res:
  1330. error_detail = f"Ollama: {res['error']}"
  1331. except Exception:
  1332. error_detail = f"Ollama: {e}"
  1333. raise HTTPException(
  1334. status_code=r.status_code if r else 500,
  1335. detail=error_detail,
  1336. )
  1337. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  1338. # Filter models based on user access control
  1339. filtered_models = []
  1340. for model in models:
  1341. model_info = Models.get_model_by_id(model["id"])
  1342. if model_info:
  1343. if user.id == model_info.user_id or has_access(
  1344. user.id, type="read", access_control=model_info.access_control
  1345. ):
  1346. filtered_models.append(model)
  1347. models = filtered_models
  1348. return {
  1349. "data": models,
  1350. "object": "list",
  1351. }
  1352. class UrlForm(BaseModel):
  1353. url: str
  1354. class UploadBlobForm(BaseModel):
  1355. filename: str
  1356. def parse_huggingface_url(hf_url):
  1357. try:
  1358. # Parse the URL
  1359. parsed_url = urlparse(hf_url)
  1360. # Get the path and split it into components
  1361. path_components = parsed_url.path.split("/")
  1362. # Extract the desired output
  1363. model_file = path_components[-1]
  1364. return model_file
  1365. except ValueError:
  1366. return None
  1367. async def download_file_stream(
  1368. ollama_url, file_url, file_path, file_name, chunk_size=1024 * 1024
  1369. ):
  1370. done = False
  1371. if os.path.exists(file_path):
  1372. current_size = os.path.getsize(file_path)
  1373. else:
  1374. current_size = 0
  1375. headers = {"Range": f"bytes={current_size}-"} if current_size > 0 else {}
  1376. timeout = aiohttp.ClientTimeout(total=600) # Set the timeout
  1377. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  1378. async with session.get(
  1379. file_url, headers=headers, ssl=AIOHTTP_CLIENT_SESSION_SSL
  1380. ) as response:
  1381. total_size = int(response.headers.get("content-length", 0)) + current_size
  1382. with open(file_path, "ab+") as file:
  1383. async for data in response.content.iter_chunked(chunk_size):
  1384. current_size += len(data)
  1385. file.write(data)
  1386. done = current_size == total_size
  1387. progress = round((current_size / total_size) * 100, 2)
  1388. yield f'data: {{"progress": {progress}, "completed": {current_size}, "total": {total_size}}}\n\n'
  1389. if done:
  1390. file.seek(0)
  1391. chunk_size = 1024 * 1024 * 2
  1392. hashed = calculate_sha256(file, chunk_size)
  1393. file.seek(0)
  1394. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  1395. response = requests.post(url, data=file)
  1396. if response.ok:
  1397. res = {
  1398. "done": done,
  1399. "blob": f"sha256:{hashed}",
  1400. "name": file_name,
  1401. }
  1402. os.remove(file_path)
  1403. yield f"data: {json.dumps(res)}\n\n"
  1404. else:
  1405. raise "Ollama: Could not create blob, Please try again."
  1406. # url = "https://huggingface.co/TheBloke/stablelm-zephyr-3b-GGUF/resolve/main/stablelm-zephyr-3b.Q2_K.gguf"
  1407. @router.post("/models/download")
  1408. @router.post("/models/download/{url_idx}")
  1409. async def download_model(
  1410. request: Request,
  1411. form_data: UrlForm,
  1412. url_idx: Optional[int] = None,
  1413. user=Depends(get_admin_user),
  1414. ):
  1415. allowed_hosts = ["https://huggingface.co/", "https://github.com/"]
  1416. if not any(form_data.url.startswith(host) for host in allowed_hosts):
  1417. raise HTTPException(
  1418. status_code=400,
  1419. detail="Invalid file_url. Only URLs from allowed hosts are permitted.",
  1420. )
  1421. if url_idx is None:
  1422. url_idx = 0
  1423. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1424. file_name = parse_huggingface_url(form_data.url)
  1425. if file_name:
  1426. file_path = f"{UPLOAD_DIR}/{file_name}"
  1427. return StreamingResponse(
  1428. download_file_stream(url, form_data.url, file_path, file_name),
  1429. )
  1430. else:
  1431. return None
  1432. # TODO: Progress bar does not reflect size & duration of upload.
  1433. @router.post("/models/upload")
  1434. @router.post("/models/upload/{url_idx}")
  1435. async def upload_model(
  1436. request: Request,
  1437. file: UploadFile = File(...),
  1438. url_idx: Optional[int] = None,
  1439. user=Depends(get_admin_user),
  1440. ):
  1441. if url_idx is None:
  1442. url_idx = 0
  1443. ollama_url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1444. filename = os.path.basename(file.filename)
  1445. file_path = os.path.join(UPLOAD_DIR, filename)
  1446. os.makedirs(UPLOAD_DIR, exist_ok=True)
  1447. # --- P1: save file locally ---
  1448. chunk_size = 1024 * 1024 * 2 # 2 MB chunks
  1449. with open(file_path, "wb") as out_f:
  1450. while True:
  1451. chunk = file.file.read(chunk_size)
  1452. # log.info(f"Chunk: {str(chunk)}") # DEBUG
  1453. if not chunk:
  1454. break
  1455. out_f.write(chunk)
  1456. async def file_process_stream():
  1457. nonlocal ollama_url
  1458. total_size = os.path.getsize(file_path)
  1459. log.info(f"Total Model Size: {str(total_size)}") # DEBUG
  1460. # --- P2: SSE progress + calculate sha256 hash ---
  1461. file_hash = calculate_sha256(file_path, chunk_size)
  1462. log.info(f"Model Hash: {str(file_hash)}") # DEBUG
  1463. try:
  1464. with open(file_path, "rb") as f:
  1465. bytes_read = 0
  1466. while chunk := f.read(chunk_size):
  1467. bytes_read += len(chunk)
  1468. progress = round(bytes_read / total_size * 100, 2)
  1469. data_msg = {
  1470. "progress": progress,
  1471. "total": total_size,
  1472. "completed": bytes_read,
  1473. }
  1474. yield f"data: {json.dumps(data_msg)}\n\n"
  1475. # --- P3: Upload to ollama /api/blobs ---
  1476. with open(file_path, "rb") as f:
  1477. url = f"{ollama_url}/api/blobs/sha256:{file_hash}"
  1478. response = requests.post(url, data=f)
  1479. if response.ok:
  1480. log.info(f"Uploaded to /api/blobs") # DEBUG
  1481. # Remove local file
  1482. os.remove(file_path)
  1483. # Create model in ollama
  1484. model_name, ext = os.path.splitext(filename)
  1485. log.info(f"Created Model: {model_name}") # DEBUG
  1486. create_payload = {
  1487. "model": model_name,
  1488. # Reference the file by its original name => the uploaded blob's digest
  1489. "files": {filename: f"sha256:{file_hash}"},
  1490. }
  1491. log.info(f"Model Payload: {create_payload}") # DEBUG
  1492. # Call ollama /api/create
  1493. # https://github.com/ollama/ollama/blob/main/docs/api.md#create-a-model
  1494. create_resp = requests.post(
  1495. url=f"{ollama_url}/api/create",
  1496. headers={"Content-Type": "application/json"},
  1497. data=json.dumps(create_payload),
  1498. )
  1499. if create_resp.ok:
  1500. log.info(f"API SUCCESS!") # DEBUG
  1501. done_msg = {
  1502. "done": True,
  1503. "blob": f"sha256:{file_hash}",
  1504. "name": filename,
  1505. "model_created": model_name,
  1506. }
  1507. yield f"data: {json.dumps(done_msg)}\n\n"
  1508. else:
  1509. raise Exception(
  1510. f"Failed to create model in Ollama. {create_resp.text}"
  1511. )
  1512. else:
  1513. raise Exception("Ollama: Could not create blob, Please try again.")
  1514. except Exception as e:
  1515. res = {"error": str(e)}
  1516. yield f"data: {json.dumps(res)}\n\n"
  1517. return StreamingResponse(file_process_stream(), media_type="text/event-stream")