main.py 36 KB

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