ollama.py 58 KB

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