ollama.py 57 KB

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