main.py 30 KB

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