1
0

ollama.py 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814
  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),
  79. "X-OpenWebUI-User-Id": quote(user.id),
  80. "X-OpenWebUI-User-Email": quote(user.email),
  81. "X-OpenWebUI-User-Role": quote(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),
  124. "X-OpenWebUI-User-Id": quote(user.id),
  125. "X-OpenWebUI-User-Email": quote(user.email),
  126. "X-OpenWebUI-User-Role": quote(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),
  210. "X-OpenWebUI-User-Id": quote(user.id),
  211. "X-OpenWebUI-User-Email": quote(user.email),
  212. "X-OpenWebUI-User-Role": quote(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),
  392. "X-OpenWebUI-User-Id": quote(user.id),
  393. "X-OpenWebUI-User-Email": quote(user.email),
  394. "X-OpenWebUI-User-Role": quote(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. name: str
  535. @router.post("/api/unload")
  536. async def unload_model(
  537. request: Request,
  538. form_data: ModelNameForm,
  539. user=Depends(get_admin_user),
  540. ):
  541. model_name = form_data.name
  542. if not model_name:
  543. raise HTTPException(
  544. status_code=400, detail="Missing 'name' of model to unload."
  545. )
  546. # Refresh/load models if needed, get mapping from name to URLs
  547. await get_all_models(request, user=user)
  548. models = request.app.state.OLLAMA_MODELS
  549. # Canonicalize model name (if not supplied with version)
  550. if ":" not in model_name:
  551. model_name = f"{model_name}:latest"
  552. if model_name not in models:
  553. raise HTTPException(
  554. status_code=400, detail=ERROR_MESSAGES.MODEL_NOT_FOUND(model_name)
  555. )
  556. url_indices = models[model_name]["urls"]
  557. # Send unload to ALL url_indices
  558. results = []
  559. errors = []
  560. for idx in url_indices:
  561. url = request.app.state.config.OLLAMA_BASE_URLS[idx]
  562. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  563. str(idx), request.app.state.config.OLLAMA_API_CONFIGS.get(url, {})
  564. )
  565. key = get_api_key(idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  566. prefix_id = api_config.get("prefix_id", None)
  567. if prefix_id and model_name.startswith(f"{prefix_id}."):
  568. model_name = model_name[len(f"{prefix_id}.") :]
  569. payload = {"model": model_name, "keep_alive": 0, "prompt": ""}
  570. try:
  571. res = await send_post_request(
  572. url=f"{url}/api/generate",
  573. payload=json.dumps(payload),
  574. stream=False,
  575. key=key,
  576. user=user,
  577. )
  578. results.append({"url_idx": idx, "success": True, "response": res})
  579. except Exception as e:
  580. log.exception(f"Failed to unload model on node {idx}: {e}")
  581. errors.append({"url_idx": idx, "success": False, "error": str(e)})
  582. if len(errors) > 0:
  583. raise HTTPException(
  584. status_code=500,
  585. detail=f"Failed to unload model on {len(errors)} nodes: {errors}",
  586. )
  587. return {"status": True}
  588. @router.post("/api/pull")
  589. @router.post("/api/pull/{url_idx}")
  590. async def pull_model(
  591. request: Request,
  592. form_data: ModelNameForm,
  593. url_idx: int = 0,
  594. user=Depends(get_admin_user),
  595. ):
  596. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  597. log.info(f"url: {url}")
  598. # Admin should be able to pull models from any source
  599. payload = {**form_data.model_dump(exclude_none=True), "insecure": True}
  600. return await send_post_request(
  601. url=f"{url}/api/pull",
  602. payload=json.dumps(payload),
  603. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  604. user=user,
  605. )
  606. class PushModelForm(BaseModel):
  607. name: str
  608. insecure: Optional[bool] = None
  609. stream: Optional[bool] = None
  610. @router.delete("/api/push")
  611. @router.delete("/api/push/{url_idx}")
  612. async def push_model(
  613. request: Request,
  614. form_data: PushModelForm,
  615. url_idx: Optional[int] = None,
  616. user=Depends(get_admin_user),
  617. ):
  618. if url_idx is None:
  619. await get_all_models(request, user=user)
  620. models = request.app.state.OLLAMA_MODELS
  621. if form_data.name in models:
  622. url_idx = models[form_data.name]["urls"][0]
  623. else:
  624. raise HTTPException(
  625. status_code=400,
  626. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  627. )
  628. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  629. log.debug(f"url: {url}")
  630. return await send_post_request(
  631. url=f"{url}/api/push",
  632. payload=form_data.model_dump_json(exclude_none=True).encode(),
  633. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  634. user=user,
  635. )
  636. class CreateModelForm(BaseModel):
  637. model: Optional[str] = None
  638. stream: Optional[bool] = None
  639. path: Optional[str] = None
  640. model_config = ConfigDict(extra="allow")
  641. @router.post("/api/create")
  642. @router.post("/api/create/{url_idx}")
  643. async def create_model(
  644. request: Request,
  645. form_data: CreateModelForm,
  646. url_idx: int = 0,
  647. user=Depends(get_admin_user),
  648. ):
  649. log.debug(f"form_data: {form_data}")
  650. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  651. return await send_post_request(
  652. url=f"{url}/api/create",
  653. payload=form_data.model_dump_json(exclude_none=True).encode(),
  654. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  655. user=user,
  656. )
  657. class CopyModelForm(BaseModel):
  658. source: str
  659. destination: str
  660. @router.post("/api/copy")
  661. @router.post("/api/copy/{url_idx}")
  662. async def copy_model(
  663. request: Request,
  664. form_data: CopyModelForm,
  665. url_idx: Optional[int] = None,
  666. user=Depends(get_admin_user),
  667. ):
  668. if url_idx is None:
  669. await get_all_models(request, user=user)
  670. models = request.app.state.OLLAMA_MODELS
  671. if form_data.source in models:
  672. url_idx = models[form_data.source]["urls"][0]
  673. else:
  674. raise HTTPException(
  675. status_code=400,
  676. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
  677. )
  678. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  679. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  680. try:
  681. r = requests.request(
  682. method="POST",
  683. url=f"{url}/api/copy",
  684. headers={
  685. "Content-Type": "application/json",
  686. **({"Authorization": f"Bearer {key}"} if key else {}),
  687. **(
  688. {
  689. "X-OpenWebUI-User-Name": quote(user.name),
  690. "X-OpenWebUI-User-Id": quote(user.id),
  691. "X-OpenWebUI-User-Email": quote(user.email),
  692. "X-OpenWebUI-User-Role": quote(user.role),
  693. }
  694. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  695. else {}
  696. ),
  697. },
  698. data=form_data.model_dump_json(exclude_none=True).encode(),
  699. )
  700. r.raise_for_status()
  701. log.debug(f"r.text: {r.text}")
  702. return True
  703. except Exception as e:
  704. log.exception(e)
  705. detail = None
  706. if r is not None:
  707. try:
  708. res = r.json()
  709. if "error" in res:
  710. detail = f"Ollama: {res['error']}"
  711. except Exception:
  712. detail = f"Ollama: {e}"
  713. raise HTTPException(
  714. status_code=r.status_code if r else 500,
  715. detail=detail if detail else "Open WebUI: Server Connection Error",
  716. )
  717. @router.delete("/api/delete")
  718. @router.delete("/api/delete/{url_idx}")
  719. async def delete_model(
  720. request: Request,
  721. form_data: ModelNameForm,
  722. url_idx: Optional[int] = None,
  723. user=Depends(get_admin_user),
  724. ):
  725. if url_idx is None:
  726. await get_all_models(request, user=user)
  727. models = request.app.state.OLLAMA_MODELS
  728. if form_data.name in models:
  729. url_idx = models[form_data.name]["urls"][0]
  730. else:
  731. raise HTTPException(
  732. status_code=400,
  733. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  734. )
  735. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  736. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  737. try:
  738. r = requests.request(
  739. method="DELETE",
  740. url=f"{url}/api/delete",
  741. data=form_data.model_dump_json(exclude_none=True).encode(),
  742. headers={
  743. "Content-Type": "application/json",
  744. **({"Authorization": f"Bearer {key}"} if key else {}),
  745. **(
  746. {
  747. "X-OpenWebUI-User-Name": quote(user.name),
  748. "X-OpenWebUI-User-Id": quote(user.id),
  749. "X-OpenWebUI-User-Email": quote(user.email),
  750. "X-OpenWebUI-User-Role": quote(user.role),
  751. }
  752. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  753. else {}
  754. ),
  755. },
  756. )
  757. r.raise_for_status()
  758. log.debug(f"r.text: {r.text}")
  759. return True
  760. except Exception as e:
  761. log.exception(e)
  762. detail = None
  763. if r is not None:
  764. try:
  765. res = r.json()
  766. if "error" in res:
  767. detail = f"Ollama: {res['error']}"
  768. except Exception:
  769. detail = f"Ollama: {e}"
  770. raise HTTPException(
  771. status_code=r.status_code if r else 500,
  772. detail=detail if detail else "Open WebUI: Server Connection Error",
  773. )
  774. @router.post("/api/show")
  775. async def show_model_info(
  776. request: Request, form_data: ModelNameForm, user=Depends(get_verified_user)
  777. ):
  778. await get_all_models(request, user=user)
  779. models = request.app.state.OLLAMA_MODELS
  780. if form_data.name not in models:
  781. raise HTTPException(
  782. status_code=400,
  783. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  784. )
  785. url_idx = random.choice(models[form_data.name]["urls"])
  786. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  787. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  788. try:
  789. r = requests.request(
  790. method="POST",
  791. url=f"{url}/api/show",
  792. headers={
  793. "Content-Type": "application/json",
  794. **({"Authorization": f"Bearer {key}"} if key else {}),
  795. **(
  796. {
  797. "X-OpenWebUI-User-Name": quote(user.name),
  798. "X-OpenWebUI-User-Id": quote(user.id),
  799. "X-OpenWebUI-User-Email": quote(user.email),
  800. "X-OpenWebUI-User-Role": quote(user.role),
  801. }
  802. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  803. else {}
  804. ),
  805. },
  806. data=form_data.model_dump_json(exclude_none=True).encode(),
  807. )
  808. r.raise_for_status()
  809. return r.json()
  810. except Exception as e:
  811. log.exception(e)
  812. detail = None
  813. if r is not None:
  814. try:
  815. res = r.json()
  816. if "error" in res:
  817. detail = f"Ollama: {res['error']}"
  818. except Exception:
  819. detail = f"Ollama: {e}"
  820. raise HTTPException(
  821. status_code=r.status_code if r else 500,
  822. detail=detail if detail else "Open WebUI: Server Connection Error",
  823. )
  824. class GenerateEmbedForm(BaseModel):
  825. model: str
  826. input: list[str] | str
  827. truncate: Optional[bool] = None
  828. options: Optional[dict] = None
  829. keep_alive: Optional[Union[int, str]] = None
  830. @router.post("/api/embed")
  831. @router.post("/api/embed/{url_idx}")
  832. async def embed(
  833. request: Request,
  834. form_data: GenerateEmbedForm,
  835. url_idx: Optional[int] = None,
  836. user=Depends(get_verified_user),
  837. ):
  838. log.info(f"generate_ollama_batch_embeddings {form_data}")
  839. if url_idx is None:
  840. await get_all_models(request, user=user)
  841. models = request.app.state.OLLAMA_MODELS
  842. model = form_data.model
  843. if ":" not in model:
  844. model = f"{model}:latest"
  845. if model in models:
  846. url_idx = random.choice(models[model]["urls"])
  847. else:
  848. raise HTTPException(
  849. status_code=400,
  850. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  851. )
  852. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  853. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  854. str(url_idx),
  855. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  856. )
  857. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  858. prefix_id = api_config.get("prefix_id", None)
  859. if prefix_id:
  860. form_data.model = form_data.model.replace(f"{prefix_id}.", "")
  861. try:
  862. r = requests.request(
  863. method="POST",
  864. url=f"{url}/api/embed",
  865. headers={
  866. "Content-Type": "application/json",
  867. **({"Authorization": f"Bearer {key}"} if key else {}),
  868. **(
  869. {
  870. "X-OpenWebUI-User-Name": quote(user.name),
  871. "X-OpenWebUI-User-Id": quote(user.id),
  872. "X-OpenWebUI-User-Email": quote(user.email),
  873. "X-OpenWebUI-User-Role": quote(user.role),
  874. }
  875. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  876. else {}
  877. ),
  878. },
  879. data=form_data.model_dump_json(exclude_none=True).encode(),
  880. )
  881. r.raise_for_status()
  882. data = r.json()
  883. return data
  884. except Exception as e:
  885. log.exception(e)
  886. detail = None
  887. if r is not None:
  888. try:
  889. res = r.json()
  890. if "error" in res:
  891. detail = f"Ollama: {res['error']}"
  892. except Exception:
  893. detail = f"Ollama: {e}"
  894. raise HTTPException(
  895. status_code=r.status_code if r else 500,
  896. detail=detail if detail else "Open WebUI: Server Connection Error",
  897. )
  898. class GenerateEmbeddingsForm(BaseModel):
  899. model: str
  900. prompt: str
  901. options: Optional[dict] = None
  902. keep_alive: Optional[Union[int, str]] = None
  903. @router.post("/api/embeddings")
  904. @router.post("/api/embeddings/{url_idx}")
  905. async def embeddings(
  906. request: Request,
  907. form_data: GenerateEmbeddingsForm,
  908. url_idx: Optional[int] = None,
  909. user=Depends(get_verified_user),
  910. ):
  911. log.info(f"generate_ollama_embeddings {form_data}")
  912. if url_idx is None:
  913. await get_all_models(request, user=user)
  914. models = request.app.state.OLLAMA_MODELS
  915. model = form_data.model
  916. if ":" not in model:
  917. model = f"{model}:latest"
  918. if model in models:
  919. url_idx = random.choice(models[model]["urls"])
  920. else:
  921. raise HTTPException(
  922. status_code=400,
  923. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  924. )
  925. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  926. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  927. str(url_idx),
  928. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  929. )
  930. key = get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS)
  931. prefix_id = api_config.get("prefix_id", None)
  932. if prefix_id:
  933. form_data.model = form_data.model.replace(f"{prefix_id}.", "")
  934. try:
  935. r = requests.request(
  936. method="POST",
  937. url=f"{url}/api/embeddings",
  938. headers={
  939. "Content-Type": "application/json",
  940. **({"Authorization": f"Bearer {key}"} if key else {}),
  941. **(
  942. {
  943. "X-OpenWebUI-User-Name": quote(user.name),
  944. "X-OpenWebUI-User-Id": quote(user.id),
  945. "X-OpenWebUI-User-Email": quote(user.email),
  946. "X-OpenWebUI-User-Role": quote(user.role),
  947. }
  948. if ENABLE_FORWARD_USER_INFO_HEADERS and user
  949. else {}
  950. ),
  951. },
  952. data=form_data.model_dump_json(exclude_none=True).encode(),
  953. )
  954. r.raise_for_status()
  955. data = r.json()
  956. return data
  957. except Exception as e:
  958. log.exception(e)
  959. detail = None
  960. if r is not None:
  961. try:
  962. res = r.json()
  963. if "error" in res:
  964. detail = f"Ollama: {res['error']}"
  965. except Exception:
  966. detail = f"Ollama: {e}"
  967. raise HTTPException(
  968. status_code=r.status_code if r else 500,
  969. detail=detail if detail else "Open WebUI: Server Connection Error",
  970. )
  971. class GenerateCompletionForm(BaseModel):
  972. model: str
  973. prompt: str
  974. suffix: Optional[str] = None
  975. images: Optional[list[str]] = None
  976. format: Optional[Union[dict, str]] = None
  977. options: Optional[dict] = None
  978. system: Optional[str] = None
  979. template: Optional[str] = None
  980. context: Optional[list[int]] = None
  981. stream: Optional[bool] = True
  982. raw: Optional[bool] = None
  983. keep_alive: Optional[Union[int, str]] = None
  984. @router.post("/api/generate")
  985. @router.post("/api/generate/{url_idx}")
  986. async def generate_completion(
  987. request: Request,
  988. form_data: GenerateCompletionForm,
  989. url_idx: Optional[int] = None,
  990. user=Depends(get_verified_user),
  991. ):
  992. if url_idx is None:
  993. await get_all_models(request, user=user)
  994. models = request.app.state.OLLAMA_MODELS
  995. model = form_data.model
  996. if ":" not in model:
  997. model = f"{model}:latest"
  998. if model in models:
  999. url_idx = random.choice(models[model]["urls"])
  1000. else:
  1001. raise HTTPException(
  1002. status_code=400,
  1003. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  1004. )
  1005. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1006. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  1007. str(url_idx),
  1008. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  1009. )
  1010. prefix_id = api_config.get("prefix_id", None)
  1011. if prefix_id:
  1012. form_data.model = form_data.model.replace(f"{prefix_id}.", "")
  1013. return await send_post_request(
  1014. url=f"{url}/api/generate",
  1015. payload=form_data.model_dump_json(exclude_none=True).encode(),
  1016. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  1017. user=user,
  1018. )
  1019. class ChatMessage(BaseModel):
  1020. role: str
  1021. content: Optional[str] = None
  1022. tool_calls: Optional[list[dict]] = None
  1023. images: Optional[list[str]] = None
  1024. @validator("content", pre=True)
  1025. @classmethod
  1026. def check_at_least_one_field(cls, field_value, values, **kwargs):
  1027. # Raise an error if both 'content' and 'tool_calls' are None
  1028. if field_value is None and (
  1029. "tool_calls" not in values or values["tool_calls"] is None
  1030. ):
  1031. raise ValueError(
  1032. "At least one of 'content' or 'tool_calls' must be provided"
  1033. )
  1034. return field_value
  1035. class GenerateChatCompletionForm(BaseModel):
  1036. model: str
  1037. messages: list[ChatMessage]
  1038. format: Optional[Union[dict, str]] = None
  1039. options: Optional[dict] = None
  1040. template: Optional[str] = None
  1041. stream: Optional[bool] = True
  1042. keep_alive: Optional[Union[int, str]] = None
  1043. tools: Optional[list[dict]] = None
  1044. model_config = ConfigDict(
  1045. extra="allow",
  1046. )
  1047. async def get_ollama_url(request: Request, model: str, url_idx: Optional[int] = None):
  1048. if url_idx is None:
  1049. models = request.app.state.OLLAMA_MODELS
  1050. if model not in models:
  1051. raise HTTPException(
  1052. status_code=400,
  1053. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(model),
  1054. )
  1055. url_idx = random.choice(models[model].get("urls", []))
  1056. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1057. return url, url_idx
  1058. @router.post("/api/chat")
  1059. @router.post("/api/chat/{url_idx}")
  1060. async def generate_chat_completion(
  1061. request: Request,
  1062. form_data: dict,
  1063. url_idx: Optional[int] = None,
  1064. user=Depends(get_verified_user),
  1065. bypass_filter: Optional[bool] = False,
  1066. ):
  1067. if BYPASS_MODEL_ACCESS_CONTROL:
  1068. bypass_filter = True
  1069. metadata = form_data.pop("metadata", None)
  1070. try:
  1071. form_data = GenerateChatCompletionForm(**form_data)
  1072. except Exception as e:
  1073. log.exception(e)
  1074. raise HTTPException(
  1075. status_code=400,
  1076. detail=str(e),
  1077. )
  1078. if isinstance(form_data, BaseModel):
  1079. payload = {**form_data.model_dump(exclude_none=True)}
  1080. if "metadata" in payload:
  1081. del payload["metadata"]
  1082. model_id = payload["model"]
  1083. model_info = Models.get_model_by_id(model_id)
  1084. if model_info:
  1085. if model_info.base_model_id:
  1086. payload["model"] = model_info.base_model_id
  1087. params = model_info.params.model_dump()
  1088. if params:
  1089. system = params.pop("system", None)
  1090. payload = apply_model_params_to_body_ollama(params, payload)
  1091. payload = apply_model_system_prompt_to_body(system, payload, metadata, user)
  1092. # Check if user has access to the model
  1093. if not bypass_filter and user.role == "user":
  1094. if not (
  1095. user.id == model_info.user_id
  1096. or has_access(
  1097. user.id, type="read", access_control=model_info.access_control
  1098. )
  1099. ):
  1100. raise HTTPException(
  1101. status_code=403,
  1102. detail="Model not found",
  1103. )
  1104. elif not bypass_filter:
  1105. if user.role != "admin":
  1106. raise HTTPException(
  1107. status_code=403,
  1108. detail="Model not found",
  1109. )
  1110. if ":" not in payload["model"]:
  1111. payload["model"] = f"{payload['model']}:latest"
  1112. url, url_idx = await get_ollama_url(request, payload["model"], url_idx)
  1113. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  1114. str(url_idx),
  1115. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  1116. )
  1117. prefix_id = api_config.get("prefix_id", None)
  1118. if prefix_id:
  1119. payload["model"] = payload["model"].replace(f"{prefix_id}.", "")
  1120. return await send_post_request(
  1121. url=f"{url}/api/chat",
  1122. payload=json.dumps(payload),
  1123. stream=form_data.stream,
  1124. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  1125. content_type="application/x-ndjson",
  1126. user=user,
  1127. )
  1128. # TODO: we should update this part once Ollama supports other types
  1129. class OpenAIChatMessageContent(BaseModel):
  1130. type: str
  1131. model_config = ConfigDict(extra="allow")
  1132. class OpenAIChatMessage(BaseModel):
  1133. role: str
  1134. content: Union[Optional[str], list[OpenAIChatMessageContent]]
  1135. model_config = ConfigDict(extra="allow")
  1136. class OpenAIChatCompletionForm(BaseModel):
  1137. model: str
  1138. messages: list[OpenAIChatMessage]
  1139. model_config = ConfigDict(extra="allow")
  1140. class OpenAICompletionForm(BaseModel):
  1141. model: str
  1142. prompt: str
  1143. model_config = ConfigDict(extra="allow")
  1144. @router.post("/v1/completions")
  1145. @router.post("/v1/completions/{url_idx}")
  1146. async def generate_openai_completion(
  1147. request: Request,
  1148. form_data: dict,
  1149. url_idx: Optional[int] = None,
  1150. user=Depends(get_verified_user),
  1151. ):
  1152. try:
  1153. form_data = OpenAICompletionForm(**form_data)
  1154. except Exception as e:
  1155. log.exception(e)
  1156. raise HTTPException(
  1157. status_code=400,
  1158. detail=str(e),
  1159. )
  1160. payload = {**form_data.model_dump(exclude_none=True, exclude=["metadata"])}
  1161. if "metadata" in payload:
  1162. del payload["metadata"]
  1163. model_id = form_data.model
  1164. if ":" not in model_id:
  1165. model_id = f"{model_id}:latest"
  1166. model_info = Models.get_model_by_id(model_id)
  1167. if model_info:
  1168. if model_info.base_model_id:
  1169. payload["model"] = model_info.base_model_id
  1170. params = model_info.params.model_dump()
  1171. if params:
  1172. payload = apply_model_params_to_body_openai(params, payload)
  1173. # Check if user has access to the model
  1174. if user.role == "user":
  1175. if not (
  1176. user.id == model_info.user_id
  1177. or has_access(
  1178. user.id, type="read", access_control=model_info.access_control
  1179. )
  1180. ):
  1181. raise HTTPException(
  1182. status_code=403,
  1183. detail="Model not found",
  1184. )
  1185. else:
  1186. if user.role != "admin":
  1187. raise HTTPException(
  1188. status_code=403,
  1189. detail="Model not found",
  1190. )
  1191. if ":" not in payload["model"]:
  1192. payload["model"] = f"{payload['model']}:latest"
  1193. url, url_idx = await get_ollama_url(request, payload["model"], url_idx)
  1194. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  1195. str(url_idx),
  1196. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  1197. )
  1198. prefix_id = api_config.get("prefix_id", None)
  1199. if prefix_id:
  1200. payload["model"] = payload["model"].replace(f"{prefix_id}.", "")
  1201. return await send_post_request(
  1202. url=f"{url}/v1/completions",
  1203. payload=json.dumps(payload),
  1204. stream=payload.get("stream", False),
  1205. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  1206. user=user,
  1207. )
  1208. @router.post("/v1/chat/completions")
  1209. @router.post("/v1/chat/completions/{url_idx}")
  1210. async def generate_openai_chat_completion(
  1211. request: Request,
  1212. form_data: dict,
  1213. url_idx: Optional[int] = None,
  1214. user=Depends(get_verified_user),
  1215. ):
  1216. metadata = form_data.pop("metadata", None)
  1217. try:
  1218. completion_form = OpenAIChatCompletionForm(**form_data)
  1219. except Exception as e:
  1220. log.exception(e)
  1221. raise HTTPException(
  1222. status_code=400,
  1223. detail=str(e),
  1224. )
  1225. payload = {**completion_form.model_dump(exclude_none=True, exclude=["metadata"])}
  1226. if "metadata" in payload:
  1227. del payload["metadata"]
  1228. model_id = completion_form.model
  1229. if ":" not in model_id:
  1230. model_id = f"{model_id}:latest"
  1231. model_info = Models.get_model_by_id(model_id)
  1232. if model_info:
  1233. if model_info.base_model_id:
  1234. payload["model"] = model_info.base_model_id
  1235. params = model_info.params.model_dump()
  1236. if params:
  1237. system = params.pop("system", None)
  1238. payload = apply_model_params_to_body_openai(params, payload)
  1239. payload = apply_model_system_prompt_to_body(system, payload, metadata, user)
  1240. # Check if user has access to the model
  1241. if user.role == "user":
  1242. if not (
  1243. user.id == model_info.user_id
  1244. or has_access(
  1245. user.id, type="read", access_control=model_info.access_control
  1246. )
  1247. ):
  1248. raise HTTPException(
  1249. status_code=403,
  1250. detail="Model not found",
  1251. )
  1252. else:
  1253. if user.role != "admin":
  1254. raise HTTPException(
  1255. status_code=403,
  1256. detail="Model not found",
  1257. )
  1258. if ":" not in payload["model"]:
  1259. payload["model"] = f"{payload['model']}:latest"
  1260. url, url_idx = await get_ollama_url(request, payload["model"], url_idx)
  1261. api_config = request.app.state.config.OLLAMA_API_CONFIGS.get(
  1262. str(url_idx),
  1263. request.app.state.config.OLLAMA_API_CONFIGS.get(url, {}), # Legacy support
  1264. )
  1265. prefix_id = api_config.get("prefix_id", None)
  1266. if prefix_id:
  1267. payload["model"] = payload["model"].replace(f"{prefix_id}.", "")
  1268. return await send_post_request(
  1269. url=f"{url}/v1/chat/completions",
  1270. payload=json.dumps(payload),
  1271. stream=payload.get("stream", False),
  1272. key=get_api_key(url_idx, url, request.app.state.config.OLLAMA_API_CONFIGS),
  1273. user=user,
  1274. )
  1275. @router.get("/v1/models")
  1276. @router.get("/v1/models/{url_idx}")
  1277. async def get_openai_models(
  1278. request: Request,
  1279. url_idx: Optional[int] = None,
  1280. user=Depends(get_verified_user),
  1281. ):
  1282. models = []
  1283. if url_idx is None:
  1284. model_list = await get_all_models(request, user=user)
  1285. models = [
  1286. {
  1287. "id": model["model"],
  1288. "object": "model",
  1289. "created": int(time.time()),
  1290. "owned_by": "openai",
  1291. }
  1292. for model in model_list["models"]
  1293. ]
  1294. else:
  1295. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1296. try:
  1297. r = requests.request(method="GET", url=f"{url}/api/tags")
  1298. r.raise_for_status()
  1299. model_list = r.json()
  1300. models = [
  1301. {
  1302. "id": model["model"],
  1303. "object": "model",
  1304. "created": int(time.time()),
  1305. "owned_by": "openai",
  1306. }
  1307. for model in models["models"]
  1308. ]
  1309. except Exception as e:
  1310. log.exception(e)
  1311. error_detail = "Open WebUI: Server Connection Error"
  1312. if r is not None:
  1313. try:
  1314. res = r.json()
  1315. if "error" in res:
  1316. error_detail = f"Ollama: {res['error']}"
  1317. except Exception:
  1318. error_detail = f"Ollama: {e}"
  1319. raise HTTPException(
  1320. status_code=r.status_code if r else 500,
  1321. detail=error_detail,
  1322. )
  1323. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  1324. # Filter models based on user access control
  1325. filtered_models = []
  1326. for model in models:
  1327. model_info = Models.get_model_by_id(model["id"])
  1328. if model_info:
  1329. if user.id == model_info.user_id or has_access(
  1330. user.id, type="read", access_control=model_info.access_control
  1331. ):
  1332. filtered_models.append(model)
  1333. models = filtered_models
  1334. return {
  1335. "data": models,
  1336. "object": "list",
  1337. }
  1338. class UrlForm(BaseModel):
  1339. url: str
  1340. class UploadBlobForm(BaseModel):
  1341. filename: str
  1342. def parse_huggingface_url(hf_url):
  1343. try:
  1344. # Parse the URL
  1345. parsed_url = urlparse(hf_url)
  1346. # Get the path and split it into components
  1347. path_components = parsed_url.path.split("/")
  1348. # Extract the desired output
  1349. model_file = path_components[-1]
  1350. return model_file
  1351. except ValueError:
  1352. return None
  1353. async def download_file_stream(
  1354. ollama_url, file_url, file_path, file_name, chunk_size=1024 * 1024
  1355. ):
  1356. done = False
  1357. if os.path.exists(file_path):
  1358. current_size = os.path.getsize(file_path)
  1359. else:
  1360. current_size = 0
  1361. headers = {"Range": f"bytes={current_size}-"} if current_size > 0 else {}
  1362. timeout = aiohttp.ClientTimeout(total=600) # Set the timeout
  1363. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  1364. async with session.get(
  1365. file_url, headers=headers, ssl=AIOHTTP_CLIENT_SESSION_SSL
  1366. ) as response:
  1367. total_size = int(response.headers.get("content-length", 0)) + current_size
  1368. with open(file_path, "ab+") as file:
  1369. async for data in response.content.iter_chunked(chunk_size):
  1370. current_size += len(data)
  1371. file.write(data)
  1372. done = current_size == total_size
  1373. progress = round((current_size / total_size) * 100, 2)
  1374. yield f'data: {{"progress": {progress}, "completed": {current_size}, "total": {total_size}}}\n\n'
  1375. if done:
  1376. file.seek(0)
  1377. chunk_size = 1024 * 1024 * 2
  1378. hashed = calculate_sha256(file, chunk_size)
  1379. file.seek(0)
  1380. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  1381. response = requests.post(url, data=file)
  1382. if response.ok:
  1383. res = {
  1384. "done": done,
  1385. "blob": f"sha256:{hashed}",
  1386. "name": file_name,
  1387. }
  1388. os.remove(file_path)
  1389. yield f"data: {json.dumps(res)}\n\n"
  1390. else:
  1391. raise "Ollama: Could not create blob, Please try again."
  1392. # url = "https://huggingface.co/TheBloke/stablelm-zephyr-3b-GGUF/resolve/main/stablelm-zephyr-3b.Q2_K.gguf"
  1393. @router.post("/models/download")
  1394. @router.post("/models/download/{url_idx}")
  1395. async def download_model(
  1396. request: Request,
  1397. form_data: UrlForm,
  1398. url_idx: Optional[int] = None,
  1399. user=Depends(get_admin_user),
  1400. ):
  1401. allowed_hosts = ["https://huggingface.co/", "https://github.com/"]
  1402. if not any(form_data.url.startswith(host) for host in allowed_hosts):
  1403. raise HTTPException(
  1404. status_code=400,
  1405. detail="Invalid file_url. Only URLs from allowed hosts are permitted.",
  1406. )
  1407. if url_idx is None:
  1408. url_idx = 0
  1409. url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1410. file_name = parse_huggingface_url(form_data.url)
  1411. if file_name:
  1412. file_path = f"{UPLOAD_DIR}/{file_name}"
  1413. return StreamingResponse(
  1414. download_file_stream(url, form_data.url, file_path, file_name),
  1415. )
  1416. else:
  1417. return None
  1418. # TODO: Progress bar does not reflect size & duration of upload.
  1419. @router.post("/models/upload")
  1420. @router.post("/models/upload/{url_idx}")
  1421. async def upload_model(
  1422. request: Request,
  1423. file: UploadFile = File(...),
  1424. url_idx: Optional[int] = None,
  1425. user=Depends(get_admin_user),
  1426. ):
  1427. if url_idx is None:
  1428. url_idx = 0
  1429. ollama_url = request.app.state.config.OLLAMA_BASE_URLS[url_idx]
  1430. filename = os.path.basename(file.filename)
  1431. file_path = os.path.join(UPLOAD_DIR, filename)
  1432. os.makedirs(UPLOAD_DIR, exist_ok=True)
  1433. # --- P1: save file locally ---
  1434. chunk_size = 1024 * 1024 * 2 # 2 MB chunks
  1435. with open(file_path, "wb") as out_f:
  1436. while True:
  1437. chunk = file.file.read(chunk_size)
  1438. # log.info(f"Chunk: {str(chunk)}") # DEBUG
  1439. if not chunk:
  1440. break
  1441. out_f.write(chunk)
  1442. async def file_process_stream():
  1443. nonlocal ollama_url
  1444. total_size = os.path.getsize(file_path)
  1445. log.info(f"Total Model Size: {str(total_size)}") # DEBUG
  1446. # --- P2: SSE progress + calculate sha256 hash ---
  1447. file_hash = calculate_sha256(file_path, chunk_size)
  1448. log.info(f"Model Hash: {str(file_hash)}") # DEBUG
  1449. try:
  1450. with open(file_path, "rb") as f:
  1451. bytes_read = 0
  1452. while chunk := f.read(chunk_size):
  1453. bytes_read += len(chunk)
  1454. progress = round(bytes_read / total_size * 100, 2)
  1455. data_msg = {
  1456. "progress": progress,
  1457. "total": total_size,
  1458. "completed": bytes_read,
  1459. }
  1460. yield f"data: {json.dumps(data_msg)}\n\n"
  1461. # --- P3: Upload to ollama /api/blobs ---
  1462. with open(file_path, "rb") as f:
  1463. url = f"{ollama_url}/api/blobs/sha256:{file_hash}"
  1464. response = requests.post(url, data=f)
  1465. if response.ok:
  1466. log.info(f"Uploaded to /api/blobs") # DEBUG
  1467. # Remove local file
  1468. os.remove(file_path)
  1469. # Create model in ollama
  1470. model_name, ext = os.path.splitext(filename)
  1471. log.info(f"Created Model: {model_name}") # DEBUG
  1472. create_payload = {
  1473. "model": model_name,
  1474. # Reference the file by its original name => the uploaded blob's digest
  1475. "files": {filename: f"sha256:{file_hash}"},
  1476. }
  1477. log.info(f"Model Payload: {create_payload}") # DEBUG
  1478. # Call ollama /api/create
  1479. # https://github.com/ollama/ollama/blob/main/docs/api.md#create-a-model
  1480. create_resp = requests.post(
  1481. url=f"{ollama_url}/api/create",
  1482. headers={"Content-Type": "application/json"},
  1483. data=json.dumps(create_payload),
  1484. )
  1485. if create_resp.ok:
  1486. log.info(f"API SUCCESS!") # DEBUG
  1487. done_msg = {
  1488. "done": True,
  1489. "blob": f"sha256:{file_hash}",
  1490. "name": filename,
  1491. "model_created": model_name,
  1492. }
  1493. yield f"data: {json.dumps(done_msg)}\n\n"
  1494. else:
  1495. raise Exception(
  1496. f"Failed to create model in Ollama. {create_resp.text}"
  1497. )
  1498. else:
  1499. raise Exception("Ollama: Could not create blob, Please try again.")
  1500. except Exception as e:
  1501. res = {"error": str(e)}
  1502. yield f"data: {json.dumps(res)}\n\n"
  1503. return StreamingResponse(file_process_stream(), media_type="text/event-stream")