ollama.py 58 KB

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