main.py 39 KB

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