main.py 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330
  1. from fastapi import (
  2. FastAPI,
  3. Request,
  4. Response,
  5. HTTPException,
  6. Depends,
  7. status,
  8. UploadFile,
  9. File,
  10. BackgroundTasks,
  11. )
  12. from fastapi.middleware.cors import CORSMiddleware
  13. from fastapi.responses import StreamingResponse
  14. from fastapi.concurrency import run_in_threadpool
  15. from pydantic import BaseModel, ConfigDict
  16. import os
  17. import re
  18. import copy
  19. import random
  20. import requests
  21. import json
  22. import uuid
  23. import aiohttp
  24. import asyncio
  25. import logging
  26. import time
  27. from urllib.parse import urlparse
  28. from typing import Optional, List, Union
  29. from starlette.background import BackgroundTask
  30. from apps.webui.models.models import Models
  31. from apps.webui.models.users import Users
  32. from constants import ERROR_MESSAGES
  33. from utils.utils import (
  34. decode_token,
  35. get_current_user,
  36. get_verified_user,
  37. get_admin_user,
  38. )
  39. from config import (
  40. SRC_LOG_LEVELS,
  41. OLLAMA_BASE_URLS,
  42. ENABLE_OLLAMA_API,
  43. ENABLE_MODEL_FILTER,
  44. MODEL_FILTER_LIST,
  45. UPLOAD_DIR,
  46. AppConfig,
  47. )
  48. from utils.misc import calculate_sha256
  49. log = logging.getLogger(__name__)
  50. log.setLevel(SRC_LOG_LEVELS["OLLAMA"])
  51. app = FastAPI()
  52. app.add_middleware(
  53. CORSMiddleware,
  54. allow_origins=["*"],
  55. allow_credentials=True,
  56. allow_methods=["*"],
  57. allow_headers=["*"],
  58. )
  59. app.state.config = AppConfig()
  60. app.state.config.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
  61. app.state.config.MODEL_FILTER_LIST = MODEL_FILTER_LIST
  62. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  63. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  64. app.state.MODELS = {}
  65. # TODO: Implement a more intelligent load balancing mechanism for distributing requests among multiple backend instances.
  66. # Current implementation uses a simple round-robin approach (random.choice). Consider incorporating algorithms like weighted round-robin,
  67. # least connections, or least response time for better resource utilization and performance optimization.
  68. @app.middleware("http")
  69. async def check_url(request: Request, call_next):
  70. if len(app.state.MODELS) == 0:
  71. await get_all_models()
  72. else:
  73. pass
  74. response = await call_next(request)
  75. return response
  76. @app.head("/")
  77. @app.get("/")
  78. async def get_status():
  79. return {"status": True}
  80. @app.get("/config")
  81. async def get_config(user=Depends(get_admin_user)):
  82. return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}
  83. class OllamaConfigForm(BaseModel):
  84. enable_ollama_api: Optional[bool] = None
  85. @app.post("/config/update")
  86. async def update_config(form_data: OllamaConfigForm, user=Depends(get_admin_user)):
  87. app.state.config.ENABLE_OLLAMA_API = form_data.enable_ollama_api
  88. return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}
  89. @app.get("/urls")
  90. async def get_ollama_api_urls(user=Depends(get_admin_user)):
  91. return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
  92. class UrlUpdateForm(BaseModel):
  93. urls: List[str]
  94. @app.post("/urls/update")
  95. async def update_ollama_api_url(form_data: UrlUpdateForm, user=Depends(get_admin_user)):
  96. app.state.config.OLLAMA_BASE_URLS = form_data.urls
  97. log.info(f"app.state.config.OLLAMA_BASE_URLS: {app.state.config.OLLAMA_BASE_URLS}")
  98. return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
  99. async def fetch_url(url):
  100. timeout = aiohttp.ClientTimeout(total=5)
  101. try:
  102. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  103. async with session.get(url) as response:
  104. return await response.json()
  105. except Exception as e:
  106. # Handle connection error here
  107. log.error(f"Connection error: {e}")
  108. return None
  109. async def cleanup_response(
  110. response: Optional[aiohttp.ClientResponse],
  111. session: Optional[aiohttp.ClientSession],
  112. ):
  113. if response:
  114. response.close()
  115. if session:
  116. await session.close()
  117. async def post_streaming_url(url: str, payload: str):
  118. r = None
  119. try:
  120. session = aiohttp.ClientSession(trust_env=True)
  121. r = await session.post(url, data=payload)
  122. r.raise_for_status()
  123. return StreamingResponse(
  124. r.content,
  125. status_code=r.status,
  126. headers=dict(r.headers),
  127. background=BackgroundTask(cleanup_response, response=r, session=session),
  128. )
  129. except Exception as e:
  130. error_detail = "Open WebUI: Server Connection Error"
  131. if r is not None:
  132. try:
  133. res = await r.json()
  134. if "error" in res:
  135. error_detail = f"Ollama: {res['error']}"
  136. except:
  137. error_detail = f"Ollama: {e}"
  138. raise HTTPException(
  139. status_code=r.status if r else 500,
  140. detail=error_detail,
  141. )
  142. def merge_models_lists(model_lists):
  143. merged_models = {}
  144. for idx, model_list in enumerate(model_lists):
  145. if model_list is not None:
  146. for model in model_list:
  147. digest = model["digest"]
  148. if digest not in merged_models:
  149. model["urls"] = [idx]
  150. merged_models[digest] = model
  151. else:
  152. merged_models[digest]["urls"].append(idx)
  153. return list(merged_models.values())
  154. # user=Depends(get_current_user)
  155. async def get_all_models():
  156. log.info("get_all_models()")
  157. if app.state.config.ENABLE_OLLAMA_API:
  158. tasks = [
  159. fetch_url(f"{url}/api/tags") for url in app.state.config.OLLAMA_BASE_URLS
  160. ]
  161. responses = await asyncio.gather(*tasks)
  162. models = {
  163. "models": merge_models_lists(
  164. map(
  165. lambda response: response["models"] if response else None, responses
  166. )
  167. )
  168. }
  169. else:
  170. models = {"models": []}
  171. app.state.MODELS = {model["model"]: model for model in models["models"]}
  172. return models
  173. @app.get("/api/tags")
  174. @app.get("/api/tags/{url_idx}")
  175. async def get_ollama_tags(
  176. url_idx: Optional[int] = None, user=Depends(get_verified_user)
  177. ):
  178. if url_idx == None:
  179. models = await get_all_models()
  180. if app.state.config.ENABLE_MODEL_FILTER:
  181. if user.role == "user":
  182. models["models"] = list(
  183. filter(
  184. lambda model: model["name"]
  185. in app.state.config.MODEL_FILTER_LIST,
  186. models["models"],
  187. )
  188. )
  189. return models
  190. return models
  191. else:
  192. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  193. r = None
  194. try:
  195. r = requests.request(method="GET", url=f"{url}/api/tags")
  196. r.raise_for_status()
  197. return r.json()
  198. except Exception as e:
  199. log.exception(e)
  200. error_detail = "Open WebUI: Server Connection Error"
  201. if r is not None:
  202. try:
  203. res = r.json()
  204. if "error" in res:
  205. error_detail = f"Ollama: {res['error']}"
  206. except:
  207. error_detail = f"Ollama: {e}"
  208. raise HTTPException(
  209. status_code=r.status_code if r else 500,
  210. detail=error_detail,
  211. )
  212. @app.get("/api/version")
  213. @app.get("/api/version/{url_idx}")
  214. async def get_ollama_versions(url_idx: Optional[int] = None):
  215. if app.state.config.ENABLE_OLLAMA_API:
  216. if url_idx == None:
  217. # returns lowest version
  218. tasks = [
  219. fetch_url(f"{url}/api/version")
  220. for url in app.state.config.OLLAMA_BASE_URLS
  221. ]
  222. responses = await asyncio.gather(*tasks)
  223. responses = list(filter(lambda x: x is not None, responses))
  224. if len(responses) > 0:
  225. lowest_version = min(
  226. responses,
  227. key=lambda x: tuple(
  228. map(int, re.sub(r"^v|-.*", "", x["version"]).split("."))
  229. ),
  230. )
  231. return {"version": lowest_version["version"]}
  232. else:
  233. raise HTTPException(
  234. status_code=500,
  235. detail=ERROR_MESSAGES.OLLAMA_NOT_FOUND,
  236. )
  237. else:
  238. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  239. r = None
  240. try:
  241. r = requests.request(method="GET", url=f"{url}/api/version")
  242. r.raise_for_status()
  243. return r.json()
  244. except Exception as e:
  245. log.exception(e)
  246. error_detail = "Open WebUI: Server Connection Error"
  247. if r is not None:
  248. try:
  249. res = r.json()
  250. if "error" in res:
  251. error_detail = f"Ollama: {res['error']}"
  252. except:
  253. error_detail = f"Ollama: {e}"
  254. raise HTTPException(
  255. status_code=r.status_code if r else 500,
  256. detail=error_detail,
  257. )
  258. else:
  259. return {"version": False}
  260. class ModelNameForm(BaseModel):
  261. name: str
  262. @app.post("/api/pull")
  263. @app.post("/api/pull/{url_idx}")
  264. async def pull_model(
  265. form_data: ModelNameForm, url_idx: int = 0, user=Depends(get_admin_user)
  266. ):
  267. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  268. log.info(f"url: {url}")
  269. r = None
  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 == 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 == 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. try:
  334. r = requests.request(
  335. method="POST",
  336. url=f"{url}/api/copy",
  337. data=form_data.model_dump_json(exclude_none=True).encode(),
  338. )
  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:
  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 == 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. try:
  374. r = requests.request(
  375. method="DELETE",
  376. url=f"{url}/api/delete",
  377. data=form_data.model_dump_json(exclude_none=True).encode(),
  378. )
  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:
  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. try:
  407. r = requests.request(
  408. method="POST",
  409. url=f"{url}/api/show",
  410. data=form_data.model_dump_json(exclude_none=True).encode(),
  411. )
  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:
  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 == 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. try:
  454. r = requests.request(
  455. method="POST",
  456. url=f"{url}/api/embeddings",
  457. data=form_data.model_dump_json(exclude_none=True).encode(),
  458. )
  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:
  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 == 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. try:
  494. r = requests.request(
  495. method="POST",
  496. url=f"{url}/api/embeddings",
  497. data=form_data.model_dump_json(exclude_none=True).encode(),
  498. )
  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 "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:
  515. error_detail = f"Ollama: {e}"
  516. raise 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 == 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),
  578. }
  579. model_id = form_data.model
  580. model_info = Models.get_model_by_id(model_id)
  581. if model_info:
  582. if model_info.base_model_id:
  583. payload["model"] = model_info.base_model_id
  584. model_info.params = model_info.params.model_dump()
  585. if model_info.params:
  586. payload["options"] = {}
  587. if model_info.params.get("mirostat", None):
  588. payload["options"]["mirostat"] = model_info.params.get("mirostat", None)
  589. if model_info.params.get("mirostat_eta", None):
  590. payload["options"]["mirostat_eta"] = model_info.params.get(
  591. "mirostat_eta", None
  592. )
  593. if model_info.params.get("mirostat_tau", None):
  594. payload["options"]["mirostat_tau"] = model_info.params.get(
  595. "mirostat_tau", None
  596. )
  597. if model_info.params.get("num_ctx", None):
  598. payload["options"]["num_ctx"] = model_info.params.get("num_ctx", None)
  599. if model_info.params.get("num_batch", None):
  600. payload["options"]["num_batch"] = model_info.params.get(
  601. "num_batch", None
  602. )
  603. if model_info.params.get("num_keep", None):
  604. payload["options"]["num_keep"] = model_info.params.get("num_keep", None)
  605. if model_info.params.get("repeat_last_n", None):
  606. payload["options"]["repeat_last_n"] = model_info.params.get(
  607. "repeat_last_n", None
  608. )
  609. if model_info.params.get("frequency_penalty", None):
  610. payload["options"]["repeat_penalty"] = model_info.params.get(
  611. "frequency_penalty", None
  612. )
  613. if model_info.params.get("temperature", None) is not None:
  614. payload["options"]["temperature"] = model_info.params.get(
  615. "temperature", None
  616. )
  617. if model_info.params.get("seed", None):
  618. payload["options"]["seed"] = model_info.params.get("seed", None)
  619. if model_info.params.get("stop", None):
  620. payload["options"]["stop"] = (
  621. [
  622. bytes(stop, "utf-8").decode("unicode_escape")
  623. for stop in model_info.params["stop"]
  624. ]
  625. if model_info.params.get("stop", None)
  626. else None
  627. )
  628. if model_info.params.get("tfs_z", None):
  629. payload["options"]["tfs_z"] = model_info.params.get("tfs_z", None)
  630. if model_info.params.get("max_tokens", None):
  631. payload["options"]["num_predict"] = model_info.params.get(
  632. "max_tokens", None
  633. )
  634. if model_info.params.get("top_k", None):
  635. payload["options"]["top_k"] = model_info.params.get("top_k", None)
  636. if model_info.params.get("top_p", None):
  637. payload["options"]["top_p"] = model_info.params.get("top_p", None)
  638. if model_info.params.get("use_mmap", None):
  639. payload["options"]["use_mmap"] = model_info.params.get("use_mmap", None)
  640. if model_info.params.get("use_mlock", None):
  641. payload["options"]["use_mlock"] = model_info.params.get(
  642. "use_mlock", None
  643. )
  644. if model_info.params.get("num_thread", None):
  645. payload["options"]["num_thread"] = model_info.params.get(
  646. "num_thread", None
  647. )
  648. if model_info.params.get("system", None):
  649. # Check if the payload already has a system message
  650. # If not, add a system message to the payload
  651. if payload.get("messages"):
  652. for message in payload["messages"]:
  653. if message.get("role") == "system":
  654. message["content"] = (
  655. model_info.params.get("system", None) + message["content"]
  656. )
  657. break
  658. else:
  659. payload["messages"].insert(
  660. 0,
  661. {
  662. "role": "system",
  663. "content": model_info.params.get("system", None),
  664. },
  665. )
  666. if url_idx == None:
  667. if ":" not in payload["model"]:
  668. payload["model"] = f"{payload['model']}:latest"
  669. if payload["model"] in app.state.MODELS:
  670. url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
  671. else:
  672. raise HTTPException(
  673. status_code=400,
  674. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  675. )
  676. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  677. log.info(f"url: {url}")
  678. print(payload)
  679. return await post_streaming_url(f"{url}/api/chat", json.dumps(payload))
  680. # TODO: we should update this part once Ollama supports other types
  681. class OpenAIChatMessageContent(BaseModel):
  682. type: str
  683. model_config = ConfigDict(extra="allow")
  684. class OpenAIChatMessage(BaseModel):
  685. role: str
  686. content: Union[str, OpenAIChatMessageContent]
  687. model_config = ConfigDict(extra="allow")
  688. class OpenAIChatCompletionForm(BaseModel):
  689. model: str
  690. messages: List[OpenAIChatMessage]
  691. model_config = ConfigDict(extra="allow")
  692. @app.post("/v1/chat/completions")
  693. @app.post("/v1/chat/completions/{url_idx}")
  694. async def generate_openai_chat_completion(
  695. form_data: OpenAIChatCompletionForm,
  696. url_idx: Optional[int] = None,
  697. user=Depends(get_verified_user),
  698. ):
  699. payload = {
  700. **form_data.model_dump(exclude_none=True),
  701. }
  702. model_id = form_data.model
  703. model_info = Models.get_model_by_id(model_id)
  704. if model_info:
  705. if model_info.base_model_id:
  706. payload["model"] = model_info.base_model_id
  707. model_info.params = model_info.params.model_dump()
  708. if model_info.params:
  709. payload["temperature"] = model_info.params.get("temperature", None)
  710. payload["top_p"] = model_info.params.get("top_p", None)
  711. payload["max_tokens"] = model_info.params.get("max_tokens", None)
  712. payload["frequency_penalty"] = model_info.params.get(
  713. "frequency_penalty", None
  714. )
  715. payload["seed"] = model_info.params.get("seed", None)
  716. payload["stop"] = (
  717. [
  718. bytes(stop, "utf-8").decode("unicode_escape")
  719. for stop in model_info.params["stop"]
  720. ]
  721. if model_info.params.get("stop", None)
  722. else None
  723. )
  724. if model_info.params.get("system", None):
  725. # Check if the payload already has a system message
  726. # If not, add a system message to the payload
  727. if payload.get("messages"):
  728. for message in payload["messages"]:
  729. if message.get("role") == "system":
  730. message["content"] = (
  731. model_info.params.get("system", None) + message["content"]
  732. )
  733. break
  734. else:
  735. payload["messages"].insert(
  736. 0,
  737. {
  738. "role": "system",
  739. "content": model_info.params.get("system", None),
  740. },
  741. )
  742. if url_idx == None:
  743. if ":" not in payload["model"]:
  744. payload["model"] = f"{payload['model']}:latest"
  745. if payload["model"] in app.state.MODELS:
  746. url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
  747. else:
  748. raise HTTPException(
  749. status_code=400,
  750. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  751. )
  752. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  753. log.info(f"url: {url}")
  754. return await post_streaming_url(f"{url}/v1/chat/completions", json.dumps(payload))
  755. @app.get("/v1/models")
  756. @app.get("/v1/models/{url_idx}")
  757. async def get_openai_models(
  758. url_idx: Optional[int] = None,
  759. user=Depends(get_verified_user),
  760. ):
  761. if url_idx == None:
  762. models = await get_all_models()
  763. if app.state.config.ENABLE_MODEL_FILTER:
  764. if user.role == "user":
  765. models["models"] = list(
  766. filter(
  767. lambda model: model["name"]
  768. in app.state.config.MODEL_FILTER_LIST,
  769. models["models"],
  770. )
  771. )
  772. return {
  773. "data": [
  774. {
  775. "id": model["model"],
  776. "object": "model",
  777. "created": int(time.time()),
  778. "owned_by": "openai",
  779. }
  780. for model in models["models"]
  781. ],
  782. "object": "list",
  783. }
  784. else:
  785. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  786. try:
  787. r = requests.request(method="GET", url=f"{url}/api/tags")
  788. r.raise_for_status()
  789. models = r.json()
  790. return {
  791. "data": [
  792. {
  793. "id": model["model"],
  794. "object": "model",
  795. "created": int(time.time()),
  796. "owned_by": "openai",
  797. }
  798. for model in models["models"]
  799. ],
  800. "object": "list",
  801. }
  802. except Exception as e:
  803. log.exception(e)
  804. error_detail = "Open WebUI: Server Connection Error"
  805. if r is not None:
  806. try:
  807. res = r.json()
  808. if "error" in res:
  809. error_detail = f"Ollama: {res['error']}"
  810. except:
  811. error_detail = f"Ollama: {e}"
  812. raise HTTPException(
  813. status_code=r.status_code if r else 500,
  814. detail=error_detail,
  815. )
  816. class UrlForm(BaseModel):
  817. url: str
  818. class UploadBlobForm(BaseModel):
  819. filename: str
  820. def parse_huggingface_url(hf_url):
  821. try:
  822. # Parse the URL
  823. parsed_url = urlparse(hf_url)
  824. # Get the path and split it into components
  825. path_components = parsed_url.path.split("/")
  826. # Extract the desired output
  827. user_repo = "/".join(path_components[1:3])
  828. model_file = path_components[-1]
  829. return model_file
  830. except ValueError:
  831. return None
  832. async def download_file_stream(
  833. ollama_url, file_url, file_path, file_name, chunk_size=1024 * 1024
  834. ):
  835. done = False
  836. if os.path.exists(file_path):
  837. current_size = os.path.getsize(file_path)
  838. else:
  839. current_size = 0
  840. headers = {"Range": f"bytes={current_size}-"} if current_size > 0 else {}
  841. timeout = aiohttp.ClientTimeout(total=600) # Set the timeout
  842. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  843. async with session.get(file_url, headers=headers) as response:
  844. total_size = int(response.headers.get("content-length", 0)) + current_size
  845. with open(file_path, "ab+") as file:
  846. async for data in response.content.iter_chunked(chunk_size):
  847. current_size += len(data)
  848. file.write(data)
  849. done = current_size == total_size
  850. progress = round((current_size / total_size) * 100, 2)
  851. yield f'data: {{"progress": {progress}, "completed": {current_size}, "total": {total_size}}}\n\n'
  852. if done:
  853. file.seek(0)
  854. hashed = calculate_sha256(file)
  855. file.seek(0)
  856. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  857. response = requests.post(url, data=file)
  858. if response.ok:
  859. res = {
  860. "done": done,
  861. "blob": f"sha256:{hashed}",
  862. "name": file_name,
  863. }
  864. os.remove(file_path)
  865. yield f"data: {json.dumps(res)}\n\n"
  866. else:
  867. raise "Ollama: Could not create blob, Please try again."
  868. # def number_generator():
  869. # for i in range(1, 101):
  870. # yield f"data: {i}\n"
  871. # url = "https://huggingface.co/TheBloke/stablelm-zephyr-3b-GGUF/resolve/main/stablelm-zephyr-3b.Q2_K.gguf"
  872. @app.post("/models/download")
  873. @app.post("/models/download/{url_idx}")
  874. async def download_model(
  875. form_data: UrlForm,
  876. url_idx: Optional[int] = None,
  877. ):
  878. allowed_hosts = ["https://huggingface.co/", "https://github.com/"]
  879. if not any(form_data.url.startswith(host) for host in allowed_hosts):
  880. raise HTTPException(
  881. status_code=400,
  882. detail="Invalid file_url. Only URLs from allowed hosts are permitted.",
  883. )
  884. if url_idx == None:
  885. url_idx = 0
  886. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  887. file_name = parse_huggingface_url(form_data.url)
  888. if file_name:
  889. file_path = f"{UPLOAD_DIR}/{file_name}"
  890. return StreamingResponse(
  891. download_file_stream(url, form_data.url, file_path, file_name),
  892. )
  893. else:
  894. return None
  895. @app.post("/models/upload")
  896. @app.post("/models/upload/{url_idx}")
  897. def upload_model(file: UploadFile = File(...), url_idx: Optional[int] = None):
  898. if url_idx == None:
  899. url_idx = 0
  900. ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  901. file_path = f"{UPLOAD_DIR}/{file.filename}"
  902. # Save file in chunks
  903. with open(file_path, "wb+") as f:
  904. for chunk in file.file:
  905. f.write(chunk)
  906. def file_process_stream():
  907. nonlocal ollama_url
  908. total_size = os.path.getsize(file_path)
  909. chunk_size = 1024 * 1024
  910. try:
  911. with open(file_path, "rb") as f:
  912. total = 0
  913. done = False
  914. while not done:
  915. chunk = f.read(chunk_size)
  916. if not chunk:
  917. done = True
  918. continue
  919. total += len(chunk)
  920. progress = round((total / total_size) * 100, 2)
  921. res = {
  922. "progress": progress,
  923. "total": total_size,
  924. "completed": total,
  925. }
  926. yield f"data: {json.dumps(res)}\n\n"
  927. if done:
  928. f.seek(0)
  929. hashed = calculate_sha256(f)
  930. f.seek(0)
  931. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  932. response = requests.post(url, data=f)
  933. if response.ok:
  934. res = {
  935. "done": done,
  936. "blob": f"sha256:{hashed}",
  937. "name": file.filename,
  938. }
  939. os.remove(file_path)
  940. yield f"data: {json.dumps(res)}\n\n"
  941. else:
  942. raise Exception(
  943. "Ollama: Could not create blob, Please try again."
  944. )
  945. except Exception as e:
  946. res = {"error": str(e)}
  947. yield f"data: {json.dumps(res)}\n\n"
  948. return StreamingResponse(file_process_stream(), media_type="text/event-stream")
  949. # async def upload_model(file: UploadFile = File(), url_idx: Optional[int] = None):
  950. # if url_idx == None:
  951. # url_idx = 0
  952. # url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  953. # file_location = os.path.join(UPLOAD_DIR, file.filename)
  954. # total_size = file.size
  955. # async def file_upload_generator(file):
  956. # print(file)
  957. # try:
  958. # async with aiofiles.open(file_location, "wb") as f:
  959. # completed_size = 0
  960. # while True:
  961. # chunk = await file.read(1024*1024)
  962. # if not chunk:
  963. # break
  964. # await f.write(chunk)
  965. # completed_size += len(chunk)
  966. # progress = (completed_size / total_size) * 100
  967. # print(progress)
  968. # yield f'data: {json.dumps({"status": "uploading", "percentage": progress, "total": total_size, "completed": completed_size, "done": False})}\n'
  969. # except Exception as e:
  970. # print(e)
  971. # yield f"data: {json.dumps({'status': 'error', 'message': str(e)})}\n"
  972. # finally:
  973. # await file.close()
  974. # print("done")
  975. # yield f'data: {json.dumps({"status": "completed", "percentage": 100, "total": total_size, "completed": completed_size, "done": True})}\n'
  976. # return StreamingResponse(
  977. # file_upload_generator(copy.deepcopy(file)), media_type="text/event-stream"
  978. # )
  979. @app.api_route("/{path:path}", methods=["GET", "POST", "PUT", "DELETE"])
  980. async def deprecated_proxy(
  981. path: str, request: Request, user=Depends(get_verified_user)
  982. ):
  983. url = app.state.config.OLLAMA_BASE_URLS[0]
  984. target_url = f"{url}/{path}"
  985. body = await request.body()
  986. headers = dict(request.headers)
  987. if user.role in ["user", "admin"]:
  988. if path in ["pull", "delete", "push", "copy", "create"]:
  989. if user.role != "admin":
  990. raise HTTPException(
  991. status_code=status.HTTP_401_UNAUTHORIZED,
  992. detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
  993. )
  994. else:
  995. raise HTTPException(
  996. status_code=status.HTTP_401_UNAUTHORIZED,
  997. detail=ERROR_MESSAGES.ACCESS_PROHIBITED,
  998. )
  999. headers.pop("host", None)
  1000. headers.pop("authorization", None)
  1001. headers.pop("origin", None)
  1002. headers.pop("referer", None)
  1003. r = None
  1004. def get_request():
  1005. nonlocal r
  1006. request_id = str(uuid.uuid4())
  1007. try:
  1008. REQUEST_POOL.append(request_id)
  1009. def stream_content():
  1010. try:
  1011. if path == "generate":
  1012. data = json.loads(body.decode("utf-8"))
  1013. if data.get("stream", True):
  1014. yield json.dumps({"id": request_id, "done": False}) + "\n"
  1015. elif path == "chat":
  1016. yield json.dumps({"id": request_id, "done": False}) + "\n"
  1017. for chunk in r.iter_content(chunk_size=8192):
  1018. if request_id in REQUEST_POOL:
  1019. yield chunk
  1020. else:
  1021. log.warning("User: canceled request")
  1022. break
  1023. finally:
  1024. if hasattr(r, "close"):
  1025. r.close()
  1026. if request_id in REQUEST_POOL:
  1027. REQUEST_POOL.remove(request_id)
  1028. r = requests.request(
  1029. method=request.method,
  1030. url=target_url,
  1031. data=body,
  1032. headers=headers,
  1033. stream=True,
  1034. )
  1035. r.raise_for_status()
  1036. # r.close()
  1037. return StreamingResponse(
  1038. stream_content(),
  1039. status_code=r.status_code,
  1040. headers=dict(r.headers),
  1041. )
  1042. except Exception as e:
  1043. raise e
  1044. try:
  1045. return await run_in_threadpool(get_request)
  1046. except Exception as e:
  1047. error_detail = "Open WebUI: Server Connection Error"
  1048. if r is not None:
  1049. try:
  1050. res = r.json()
  1051. if "error" in res:
  1052. error_detail = f"Ollama: {res['error']}"
  1053. except:
  1054. error_detail = f"Ollama: {e}"
  1055. raise HTTPException(
  1056. status_code=r.status_code if r else 500,
  1057. detail=error_detail,
  1058. )