main.py 31 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091
  1. from fastapi import (
  2. FastAPI,
  3. Request,
  4. HTTPException,
  5. Depends,
  6. UploadFile,
  7. File,
  8. )
  9. from fastapi.middleware.cors import CORSMiddleware
  10. from fastapi.responses import StreamingResponse
  11. from pydantic import BaseModel, ConfigDict
  12. import os
  13. import re
  14. import random
  15. import requests
  16. import json
  17. import aiohttp
  18. import asyncio
  19. import logging
  20. import time
  21. from urllib.parse import urlparse
  22. from typing import Optional, Union
  23. from starlette.background import BackgroundTask
  24. from apps.webui.models.models import Models
  25. from constants import ERROR_MESSAGES
  26. from utils.utils import (
  27. get_verified_user,
  28. get_admin_user,
  29. )
  30. from config import (
  31. SRC_LOG_LEVELS,
  32. OLLAMA_BASE_URLS,
  33. ENABLE_OLLAMA_API,
  34. AIOHTTP_CLIENT_TIMEOUT,
  35. ENABLE_MODEL_FILTER,
  36. MODEL_FILTER_LIST,
  37. UPLOAD_DIR,
  38. AppConfig,
  39. CORS_ALLOW_ORIGIN,
  40. )
  41. from utils.misc import (
  42. calculate_sha256,
  43. apply_model_params_to_body_ollama,
  44. apply_model_params_to_body_openai,
  45. apply_model_system_prompt_to_body,
  46. )
  47. log = logging.getLogger(__name__)
  48. log.setLevel(SRC_LOG_LEVELS["OLLAMA"])
  49. app = FastAPI()
  50. app.add_middleware(
  51. CORSMiddleware,
  52. allow_origins=CORS_ALLOW_ORIGIN,
  53. allow_credentials=True,
  54. allow_methods=["*"],
  55. allow_headers=["*"],
  56. )
  57. app.state.config = AppConfig()
  58. app.state.config.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
  59. app.state.config.MODEL_FILTER_LIST = MODEL_FILTER_LIST
  60. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  61. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  62. app.state.MODELS = {}
  63. # TODO: Implement a more intelligent load balancing mechanism for distributing requests among multiple backend instances.
  64. # Current implementation uses a simple round-robin approach (random.choice). Consider incorporating algorithms like weighted round-robin,
  65. # least connections, or least response time for better resource utilization and performance optimization.
  66. @app.middleware("http")
  67. async def check_url(request: Request, call_next):
  68. if len(app.state.MODELS) == 0:
  69. await get_all_models()
  70. else:
  71. pass
  72. response = await call_next(request)
  73. return response
  74. @app.head("/")
  75. @app.get("/")
  76. async def get_status():
  77. return {"status": True}
  78. @app.get("/config")
  79. async def get_config(user=Depends(get_admin_user)):
  80. return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}
  81. class OllamaConfigForm(BaseModel):
  82. enable_ollama_api: Optional[bool] = None
  83. @app.post("/config/update")
  84. async def update_config(form_data: OllamaConfigForm, user=Depends(get_admin_user)):
  85. app.state.config.ENABLE_OLLAMA_API = form_data.enable_ollama_api
  86. return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}
  87. @app.get("/urls")
  88. async def get_ollama_api_urls(user=Depends(get_admin_user)):
  89. return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
  90. class UrlUpdateForm(BaseModel):
  91. urls: list[str]
  92. @app.post("/urls/update")
  93. async def update_ollama_api_url(form_data: UrlUpdateForm, user=Depends(get_admin_user)):
  94. app.state.config.OLLAMA_BASE_URLS = form_data.urls
  95. log.info(f"app.state.config.OLLAMA_BASE_URLS: {app.state.config.OLLAMA_BASE_URLS}")
  96. return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
  97. async def fetch_url(url):
  98. timeout = aiohttp.ClientTimeout(total=5)
  99. try:
  100. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  101. async with session.get(url) as response:
  102. return await response.json()
  103. except Exception as e:
  104. # Handle connection error here
  105. log.error(f"Connection error: {e}")
  106. return None
  107. async def cleanup_response(
  108. response: Optional[aiohttp.ClientResponse],
  109. session: Optional[aiohttp.ClientSession],
  110. ):
  111. if response:
  112. response.close()
  113. if session:
  114. await session.close()
  115. async def post_streaming_url(
  116. url: str, payload: Union[str, bytes], stream: bool = True, content_type=None
  117. ):
  118. r = None
  119. try:
  120. session = aiohttp.ClientSession(
  121. trust_env=True, timeout=aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT)
  122. )
  123. r = await session.post(
  124. url,
  125. data=payload,
  126. headers={"Content-Type": "application/json"},
  127. )
  128. r.raise_for_status()
  129. if stream:
  130. headers = dict(r.headers)
  131. if content_type:
  132. headers["Content-Type"] = content_type
  133. return StreamingResponse(
  134. r.content,
  135. status_code=r.status,
  136. headers=headers,
  137. background=BackgroundTask(
  138. cleanup_response, response=r, session=session
  139. ),
  140. )
  141. else:
  142. res = await r.json()
  143. await cleanup_response(r, session)
  144. return res
  145. except Exception as e:
  146. error_detail = "Open WebUI: Server Connection Error"
  147. if r is not None:
  148. try:
  149. res = await r.json()
  150. if "error" in res:
  151. error_detail = f"Ollama: {res['error']}"
  152. except Exception:
  153. error_detail = f"Ollama: {e}"
  154. raise HTTPException(
  155. status_code=r.status if r else 500,
  156. detail=error_detail,
  157. )
  158. def merge_models_lists(model_lists):
  159. merged_models = {}
  160. for idx, model_list in enumerate(model_lists):
  161. if model_list is not None:
  162. for model in model_list:
  163. digest = model["digest"]
  164. if digest not in merged_models:
  165. model["urls"] = [idx]
  166. merged_models[digest] = model
  167. else:
  168. merged_models[digest]["urls"].append(idx)
  169. return list(merged_models.values())
  170. async def get_all_models():
  171. log.info("get_all_models()")
  172. if app.state.config.ENABLE_OLLAMA_API:
  173. tasks = [
  174. fetch_url(f"{url}/api/tags") for url in app.state.config.OLLAMA_BASE_URLS
  175. ]
  176. responses = await asyncio.gather(*tasks)
  177. models = {
  178. "models": merge_models_lists(
  179. map(
  180. lambda response: response["models"] if response else None, responses
  181. )
  182. )
  183. }
  184. else:
  185. models = {"models": []}
  186. app.state.MODELS = {model["model"]: model for model in models["models"]}
  187. return models
  188. @app.get("/api/tags")
  189. @app.get("/api/tags/{url_idx}")
  190. async def get_ollama_tags(
  191. url_idx: Optional[int] = None, user=Depends(get_verified_user)
  192. ):
  193. if url_idx is None:
  194. models = await get_all_models()
  195. if app.state.config.ENABLE_MODEL_FILTER:
  196. if user.role == "user":
  197. models["models"] = list(
  198. filter(
  199. lambda model: model["name"]
  200. in app.state.config.MODEL_FILTER_LIST,
  201. models["models"],
  202. )
  203. )
  204. return models
  205. return models
  206. else:
  207. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  208. r = None
  209. try:
  210. r = requests.request(method="GET", url=f"{url}/api/tags")
  211. r.raise_for_status()
  212. return r.json()
  213. except Exception as e:
  214. log.exception(e)
  215. error_detail = "Open WebUI: Server Connection Error"
  216. if r is not None:
  217. try:
  218. res = r.json()
  219. if "error" in res:
  220. error_detail = f"Ollama: {res['error']}"
  221. except Exception:
  222. error_detail = f"Ollama: {e}"
  223. raise HTTPException(
  224. status_code=r.status_code if r else 500,
  225. detail=error_detail,
  226. )
  227. @app.get("/api/version")
  228. @app.get("/api/version/{url_idx}")
  229. async def get_ollama_versions(url_idx: Optional[int] = None):
  230. if app.state.config.ENABLE_OLLAMA_API:
  231. if url_idx is None:
  232. # returns lowest version
  233. tasks = [
  234. fetch_url(f"{url}/api/version")
  235. for url in app.state.config.OLLAMA_BASE_URLS
  236. ]
  237. responses = await asyncio.gather(*tasks)
  238. responses = list(filter(lambda x: x is not None, responses))
  239. if len(responses) > 0:
  240. lowest_version = min(
  241. responses,
  242. key=lambda x: tuple(
  243. map(int, re.sub(r"^v|-.*", "", x["version"]).split("."))
  244. ),
  245. )
  246. return {"version": lowest_version["version"]}
  247. else:
  248. raise HTTPException(
  249. status_code=500,
  250. detail=ERROR_MESSAGES.OLLAMA_NOT_FOUND,
  251. )
  252. else:
  253. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  254. r = None
  255. try:
  256. r = requests.request(method="GET", url=f"{url}/api/version")
  257. r.raise_for_status()
  258. return r.json()
  259. except Exception as e:
  260. log.exception(e)
  261. error_detail = "Open WebUI: Server Connection Error"
  262. if r is not None:
  263. try:
  264. res = r.json()
  265. if "error" in res:
  266. error_detail = f"Ollama: {res['error']}"
  267. except Exception:
  268. error_detail = f"Ollama: {e}"
  269. raise HTTPException(
  270. status_code=r.status_code if r else 500,
  271. detail=error_detail,
  272. )
  273. else:
  274. return {"version": False}
  275. class ModelNameForm(BaseModel):
  276. name: str
  277. @app.post("/api/pull")
  278. @app.post("/api/pull/{url_idx}")
  279. async def pull_model(
  280. form_data: ModelNameForm, url_idx: int = 0, user=Depends(get_admin_user)
  281. ):
  282. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  283. log.info(f"url: {url}")
  284. # Admin should be able to pull models from any source
  285. payload = {**form_data.model_dump(exclude_none=True), "insecure": True}
  286. return await post_streaming_url(f"{url}/api/pull", json.dumps(payload))
  287. class PushModelForm(BaseModel):
  288. name: str
  289. insecure: Optional[bool] = None
  290. stream: Optional[bool] = None
  291. @app.delete("/api/push")
  292. @app.delete("/api/push/{url_idx}")
  293. async def push_model(
  294. form_data: PushModelForm,
  295. url_idx: Optional[int] = None,
  296. user=Depends(get_admin_user),
  297. ):
  298. if url_idx is None:
  299. if form_data.name in app.state.MODELS:
  300. url_idx = app.state.MODELS[form_data.name]["urls"][0]
  301. else:
  302. raise HTTPException(
  303. status_code=400,
  304. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  305. )
  306. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  307. log.debug(f"url: {url}")
  308. return await post_streaming_url(
  309. f"{url}/api/push", form_data.model_dump_json(exclude_none=True).encode()
  310. )
  311. class CreateModelForm(BaseModel):
  312. name: str
  313. modelfile: Optional[str] = None
  314. stream: Optional[bool] = None
  315. path: Optional[str] = None
  316. @app.post("/api/create")
  317. @app.post("/api/create/{url_idx}")
  318. async def create_model(
  319. form_data: CreateModelForm, url_idx: int = 0, user=Depends(get_admin_user)
  320. ):
  321. log.debug(f"form_data: {form_data}")
  322. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  323. log.info(f"url: {url}")
  324. return await post_streaming_url(
  325. f"{url}/api/create", form_data.model_dump_json(exclude_none=True).encode()
  326. )
  327. class CopyModelForm(BaseModel):
  328. source: str
  329. destination: str
  330. @app.post("/api/copy")
  331. @app.post("/api/copy/{url_idx}")
  332. async def copy_model(
  333. form_data: CopyModelForm,
  334. url_idx: Optional[int] = None,
  335. user=Depends(get_admin_user),
  336. ):
  337. if url_idx is None:
  338. if form_data.source in app.state.MODELS:
  339. url_idx = app.state.MODELS[form_data.source]["urls"][0]
  340. else:
  341. raise HTTPException(
  342. status_code=400,
  343. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.source),
  344. )
  345. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  346. log.info(f"url: {url}")
  347. r = requests.request(
  348. method="POST",
  349. url=f"{url}/api/copy",
  350. headers={"Content-Type": "application/json"},
  351. data=form_data.model_dump_json(exclude_none=True).encode(),
  352. )
  353. try:
  354. r.raise_for_status()
  355. log.debug(f"r.text: {r.text}")
  356. return True
  357. except Exception as e:
  358. log.exception(e)
  359. error_detail = "Open WebUI: Server Connection Error"
  360. if r is not None:
  361. try:
  362. res = r.json()
  363. if "error" in res:
  364. error_detail = f"Ollama: {res['error']}"
  365. except Exception:
  366. error_detail = f"Ollama: {e}"
  367. raise HTTPException(
  368. status_code=r.status_code if r else 500,
  369. detail=error_detail,
  370. )
  371. @app.delete("/api/delete")
  372. @app.delete("/api/delete/{url_idx}")
  373. async def delete_model(
  374. form_data: ModelNameForm,
  375. url_idx: Optional[int] = None,
  376. user=Depends(get_admin_user),
  377. ):
  378. if url_idx is None:
  379. if form_data.name in app.state.MODELS:
  380. url_idx = app.state.MODELS[form_data.name]["urls"][0]
  381. else:
  382. raise HTTPException(
  383. status_code=400,
  384. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  385. )
  386. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  387. log.info(f"url: {url}")
  388. r = requests.request(
  389. method="DELETE",
  390. url=f"{url}/api/delete",
  391. headers={"Content-Type": "application/json"},
  392. data=form_data.model_dump_json(exclude_none=True).encode(),
  393. )
  394. try:
  395. r.raise_for_status()
  396. log.debug(f"r.text: {r.text}")
  397. return True
  398. except Exception as e:
  399. log.exception(e)
  400. error_detail = "Open WebUI: Server Connection Error"
  401. if r is not None:
  402. try:
  403. res = r.json()
  404. if "error" in res:
  405. error_detail = f"Ollama: {res['error']}"
  406. except Exception:
  407. error_detail = f"Ollama: {e}"
  408. raise HTTPException(
  409. status_code=r.status_code if r else 500,
  410. detail=error_detail,
  411. )
  412. @app.post("/api/show")
  413. async def show_model_info(form_data: ModelNameForm, user=Depends(get_verified_user)):
  414. if form_data.name not in app.state.MODELS:
  415. raise HTTPException(
  416. status_code=400,
  417. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.name),
  418. )
  419. url_idx = random.choice(app.state.MODELS[form_data.name]["urls"])
  420. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  421. log.info(f"url: {url}")
  422. r = requests.request(
  423. method="POST",
  424. url=f"{url}/api/show",
  425. headers={"Content-Type": "application/json"},
  426. data=form_data.model_dump_json(exclude_none=True).encode(),
  427. )
  428. try:
  429. r.raise_for_status()
  430. return r.json()
  431. except Exception as e:
  432. log.exception(e)
  433. error_detail = "Open WebUI: Server Connection Error"
  434. if r is not None:
  435. try:
  436. res = r.json()
  437. if "error" in res:
  438. error_detail = f"Ollama: {res['error']}"
  439. except Exception:
  440. error_detail = f"Ollama: {e}"
  441. raise HTTPException(
  442. status_code=r.status_code if r else 500,
  443. detail=error_detail,
  444. )
  445. class GenerateEmbeddingsForm(BaseModel):
  446. model: str
  447. prompt: str
  448. options: Optional[dict] = None
  449. keep_alive: Optional[Union[int, str]] = None
  450. @app.post("/api/embeddings")
  451. @app.post("/api/embeddings/{url_idx}")
  452. async def generate_embeddings(
  453. form_data: GenerateEmbeddingsForm,
  454. url_idx: Optional[int] = None,
  455. user=Depends(get_verified_user),
  456. ):
  457. if url_idx is None:
  458. model = form_data.model
  459. if ":" not in model:
  460. model = f"{model}:latest"
  461. if model in app.state.MODELS:
  462. url_idx = random.choice(app.state.MODELS[model]["urls"])
  463. else:
  464. raise HTTPException(
  465. status_code=400,
  466. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  467. )
  468. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  469. log.info(f"url: {url}")
  470. r = requests.request(
  471. method="POST",
  472. url=f"{url}/api/embeddings",
  473. headers={"Content-Type": "application/json"},
  474. data=form_data.model_dump_json(exclude_none=True).encode(),
  475. )
  476. try:
  477. r.raise_for_status()
  478. return r.json()
  479. except Exception as e:
  480. log.exception(e)
  481. error_detail = "Open WebUI: Server Connection Error"
  482. if r is not None:
  483. try:
  484. res = r.json()
  485. if "error" in res:
  486. error_detail = f"Ollama: {res['error']}"
  487. except Exception:
  488. error_detail = f"Ollama: {e}"
  489. raise HTTPException(
  490. status_code=r.status_code if r else 500,
  491. detail=error_detail,
  492. )
  493. def generate_ollama_embeddings(
  494. form_data: GenerateEmbeddingsForm,
  495. url_idx: Optional[int] = None,
  496. ):
  497. log.info(f"generate_ollama_embeddings {form_data}")
  498. if url_idx is None:
  499. model = form_data.model
  500. if ":" not in model:
  501. model = f"{model}:latest"
  502. if model in app.state.MODELS:
  503. url_idx = random.choice(app.state.MODELS[model]["urls"])
  504. else:
  505. raise HTTPException(
  506. status_code=400,
  507. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  508. )
  509. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  510. log.info(f"url: {url}")
  511. r = requests.request(
  512. method="POST",
  513. url=f"{url}/api/embeddings",
  514. headers={"Content-Type": "application/json"},
  515. data=form_data.model_dump_json(exclude_none=True).encode(),
  516. )
  517. try:
  518. r.raise_for_status()
  519. data = r.json()
  520. log.info(f"generate_ollama_embeddings {data}")
  521. if "embedding" in data:
  522. return data["embedding"]
  523. else:
  524. raise Exception("Something went wrong :/")
  525. except Exception as e:
  526. log.exception(e)
  527. error_detail = "Open WebUI: Server Connection Error"
  528. if r is not None:
  529. try:
  530. res = r.json()
  531. if "error" in res:
  532. error_detail = f"Ollama: {res['error']}"
  533. except Exception:
  534. error_detail = f"Ollama: {e}"
  535. raise Exception(error_detail)
  536. class GenerateCompletionForm(BaseModel):
  537. model: str
  538. prompt: str
  539. images: Optional[list[str]] = None
  540. format: Optional[str] = None
  541. options: Optional[dict] = None
  542. system: Optional[str] = None
  543. template: Optional[str] = None
  544. context: Optional[str] = None
  545. stream: Optional[bool] = True
  546. raw: Optional[bool] = None
  547. keep_alive: Optional[Union[int, str]] = None
  548. @app.post("/api/generate")
  549. @app.post("/api/generate/{url_idx}")
  550. async def generate_completion(
  551. form_data: GenerateCompletionForm,
  552. url_idx: Optional[int] = None,
  553. user=Depends(get_verified_user),
  554. ):
  555. if url_idx is None:
  556. model = form_data.model
  557. if ":" not in model:
  558. model = f"{model}:latest"
  559. if model in app.state.MODELS:
  560. url_idx = random.choice(app.state.MODELS[model]["urls"])
  561. else:
  562. raise HTTPException(
  563. status_code=400,
  564. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  565. )
  566. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  567. log.info(f"url: {url}")
  568. return await post_streaming_url(
  569. f"{url}/api/generate", form_data.model_dump_json(exclude_none=True).encode()
  570. )
  571. class ChatMessage(BaseModel):
  572. role: str
  573. content: str
  574. images: Optional[list[str]] = None
  575. class GenerateChatCompletionForm(BaseModel):
  576. model: str
  577. messages: list[ChatMessage]
  578. format: Optional[str] = None
  579. options: Optional[dict] = None
  580. template: Optional[str] = None
  581. stream: Optional[bool] = None
  582. keep_alive: Optional[Union[int, str]] = None
  583. def get_ollama_url(url_idx: Optional[int], model: str):
  584. if url_idx is None:
  585. if model not in app.state.MODELS:
  586. raise HTTPException(
  587. status_code=400,
  588. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(model),
  589. )
  590. url_idx = random.choice(app.state.MODELS[model]["urls"])
  591. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  592. return url
  593. @app.post("/api/chat")
  594. @app.post("/api/chat/{url_idx}")
  595. async def generate_chat_completion(
  596. form_data: GenerateChatCompletionForm,
  597. url_idx: Optional[int] = None,
  598. user=Depends(get_verified_user),
  599. ):
  600. payload = {**form_data.model_dump(exclude_none=True)}
  601. log.debug(f"{payload = }")
  602. if "metadata" in payload:
  603. del payload["metadata"]
  604. model_id = form_data.model
  605. if app.state.config.ENABLE_MODEL_FILTER:
  606. if user.role == "user" and model_id not in app.state.config.MODEL_FILTER_LIST:
  607. raise HTTPException(
  608. status_code=403,
  609. detail="Model not found",
  610. )
  611. model_info = Models.get_model_by_id(model_id)
  612. if model_info:
  613. if model_info.base_model_id:
  614. payload["model"] = model_info.base_model_id
  615. params = model_info.params.model_dump()
  616. if params:
  617. if payload.get("options") is None:
  618. payload["options"] = {}
  619. payload["options"] = apply_model_params_to_body_ollama(
  620. params, payload["options"]
  621. )
  622. payload = apply_model_system_prompt_to_body(params, payload, user)
  623. if ":" not in payload["model"]:
  624. payload["model"] = f"{payload['model']}:latest"
  625. url = get_ollama_url(url_idx, payload["model"])
  626. log.info(f"url: {url}")
  627. log.debug(payload)
  628. return await post_streaming_url(
  629. f"{url}/api/chat", json.dumps(payload), content_type="application/x-ndjson"
  630. )
  631. # TODO: we should update this part once Ollama supports other types
  632. class OpenAIChatMessageContent(BaseModel):
  633. type: str
  634. model_config = ConfigDict(extra="allow")
  635. class OpenAIChatMessage(BaseModel):
  636. role: str
  637. content: Union[str, OpenAIChatMessageContent]
  638. model_config = ConfigDict(extra="allow")
  639. class OpenAIChatCompletionForm(BaseModel):
  640. model: str
  641. messages: list[OpenAIChatMessage]
  642. model_config = ConfigDict(extra="allow")
  643. @app.post("/v1/chat/completions")
  644. @app.post("/v1/chat/completions/{url_idx}")
  645. async def generate_openai_chat_completion(
  646. form_data: dict,
  647. url_idx: Optional[int] = None,
  648. user=Depends(get_verified_user),
  649. ):
  650. completion_form = OpenAIChatCompletionForm(**form_data)
  651. payload = {**completion_form.model_dump(exclude_none=True, exclude=["metadata"])}
  652. if "metadata" in payload:
  653. del payload["metadata"]
  654. model_id = completion_form.model
  655. if app.state.config.ENABLE_MODEL_FILTER:
  656. if user.role == "user" and model_id not in app.state.config.MODEL_FILTER_LIST:
  657. raise HTTPException(
  658. status_code=403,
  659. detail="Model not found",
  660. )
  661. model_info = Models.get_model_by_id(model_id)
  662. if model_info:
  663. if model_info.base_model_id:
  664. payload["model"] = model_info.base_model_id
  665. params = model_info.params.model_dump()
  666. if params:
  667. payload = apply_model_params_to_body_openai(params, payload)
  668. payload = apply_model_system_prompt_to_body(params, payload, user)
  669. if ":" not in payload["model"]:
  670. payload["model"] = f"{payload['model']}:latest"
  671. url = get_ollama_url(url_idx, payload["model"])
  672. log.info(f"url: {url}")
  673. return await post_streaming_url(
  674. f"{url}/v1/chat/completions",
  675. json.dumps(payload),
  676. stream=payload.get("stream", False),
  677. )
  678. @app.get("/v1/models")
  679. @app.get("/v1/models/{url_idx}")
  680. async def get_openai_models(
  681. url_idx: Optional[int] = None,
  682. user=Depends(get_verified_user),
  683. ):
  684. if url_idx is None:
  685. models = await get_all_models()
  686. if app.state.config.ENABLE_MODEL_FILTER:
  687. if user.role == "user":
  688. models["models"] = list(
  689. filter(
  690. lambda model: model["name"]
  691. in app.state.config.MODEL_FILTER_LIST,
  692. models["models"],
  693. )
  694. )
  695. return {
  696. "data": [
  697. {
  698. "id": model["model"],
  699. "object": "model",
  700. "created": int(time.time()),
  701. "owned_by": "openai",
  702. }
  703. for model in models["models"]
  704. ],
  705. "object": "list",
  706. }
  707. else:
  708. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  709. try:
  710. r = requests.request(method="GET", url=f"{url}/api/tags")
  711. r.raise_for_status()
  712. models = r.json()
  713. return {
  714. "data": [
  715. {
  716. "id": model["model"],
  717. "object": "model",
  718. "created": int(time.time()),
  719. "owned_by": "openai",
  720. }
  721. for model in models["models"]
  722. ],
  723. "object": "list",
  724. }
  725. except Exception as e:
  726. log.exception(e)
  727. error_detail = "Open WebUI: Server Connection Error"
  728. if r is not None:
  729. try:
  730. res = r.json()
  731. if "error" in res:
  732. error_detail = f"Ollama: {res['error']}"
  733. except Exception:
  734. error_detail = f"Ollama: {e}"
  735. raise HTTPException(
  736. status_code=r.status_code if r else 500,
  737. detail=error_detail,
  738. )
  739. class UrlForm(BaseModel):
  740. url: str
  741. class UploadBlobForm(BaseModel):
  742. filename: str
  743. def parse_huggingface_url(hf_url):
  744. try:
  745. # Parse the URL
  746. parsed_url = urlparse(hf_url)
  747. # Get the path and split it into components
  748. path_components = parsed_url.path.split("/")
  749. # Extract the desired output
  750. model_file = path_components[-1]
  751. return model_file
  752. except ValueError:
  753. return None
  754. async def download_file_stream(
  755. ollama_url, file_url, file_path, file_name, chunk_size=1024 * 1024
  756. ):
  757. done = False
  758. if os.path.exists(file_path):
  759. current_size = os.path.getsize(file_path)
  760. else:
  761. current_size = 0
  762. headers = {"Range": f"bytes={current_size}-"} if current_size > 0 else {}
  763. timeout = aiohttp.ClientTimeout(total=600) # Set the timeout
  764. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  765. async with session.get(file_url, headers=headers) as response:
  766. total_size = int(response.headers.get("content-length", 0)) + current_size
  767. with open(file_path, "ab+") as file:
  768. async for data in response.content.iter_chunked(chunk_size):
  769. current_size += len(data)
  770. file.write(data)
  771. done = current_size == total_size
  772. progress = round((current_size / total_size) * 100, 2)
  773. yield f'data: {{"progress": {progress}, "completed": {current_size}, "total": {total_size}}}\n\n'
  774. if done:
  775. file.seek(0)
  776. hashed = calculate_sha256(file)
  777. file.seek(0)
  778. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  779. response = requests.post(url, data=file)
  780. if response.ok:
  781. res = {
  782. "done": done,
  783. "blob": f"sha256:{hashed}",
  784. "name": file_name,
  785. }
  786. os.remove(file_path)
  787. yield f"data: {json.dumps(res)}\n\n"
  788. else:
  789. raise "Ollama: Could not create blob, Please try again."
  790. # url = "https://huggingface.co/TheBloke/stablelm-zephyr-3b-GGUF/resolve/main/stablelm-zephyr-3b.Q2_K.gguf"
  791. @app.post("/models/download")
  792. @app.post("/models/download/{url_idx}")
  793. async def download_model(
  794. form_data: UrlForm,
  795. url_idx: Optional[int] = None,
  796. user=Depends(get_admin_user),
  797. ):
  798. allowed_hosts = ["https://huggingface.co/", "https://github.com/"]
  799. if not any(form_data.url.startswith(host) for host in allowed_hosts):
  800. raise HTTPException(
  801. status_code=400,
  802. detail="Invalid file_url. Only URLs from allowed hosts are permitted.",
  803. )
  804. if url_idx is None:
  805. url_idx = 0
  806. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  807. file_name = parse_huggingface_url(form_data.url)
  808. if file_name:
  809. file_path = f"{UPLOAD_DIR}/{file_name}"
  810. return StreamingResponse(
  811. download_file_stream(url, form_data.url, file_path, file_name),
  812. )
  813. else:
  814. return None
  815. @app.post("/models/upload")
  816. @app.post("/models/upload/{url_idx}")
  817. def upload_model(
  818. file: UploadFile = File(...),
  819. url_idx: Optional[int] = None,
  820. user=Depends(get_admin_user),
  821. ):
  822. if url_idx is None:
  823. url_idx = 0
  824. ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  825. file_path = f"{UPLOAD_DIR}/{file.filename}"
  826. # Save file in chunks
  827. with open(file_path, "wb+") as f:
  828. for chunk in file.file:
  829. f.write(chunk)
  830. def file_process_stream():
  831. nonlocal ollama_url
  832. total_size = os.path.getsize(file_path)
  833. chunk_size = 1024 * 1024
  834. try:
  835. with open(file_path, "rb") as f:
  836. total = 0
  837. done = False
  838. while not done:
  839. chunk = f.read(chunk_size)
  840. if not chunk:
  841. done = True
  842. continue
  843. total += len(chunk)
  844. progress = round((total / total_size) * 100, 2)
  845. res = {
  846. "progress": progress,
  847. "total": total_size,
  848. "completed": total,
  849. }
  850. yield f"data: {json.dumps(res)}\n\n"
  851. if done:
  852. f.seek(0)
  853. hashed = calculate_sha256(f)
  854. f.seek(0)
  855. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  856. response = requests.post(url, data=f)
  857. if response.ok:
  858. res = {
  859. "done": done,
  860. "blob": f"sha256:{hashed}",
  861. "name": file.filename,
  862. }
  863. os.remove(file_path)
  864. yield f"data: {json.dumps(res)}\n\n"
  865. else:
  866. raise Exception(
  867. "Ollama: Could not create blob, Please try again."
  868. )
  869. except Exception as e:
  870. res = {"error": str(e)}
  871. yield f"data: {json.dumps(res)}\n\n"
  872. return StreamingResponse(file_process_stream(), media_type="text/event-stream")