main.py 30 KB

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