main.py 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214
  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 utils.task import prompt_template
  40. from config import (
  41. SRC_LOG_LEVELS,
  42. OLLAMA_BASE_URLS,
  43. ENABLE_OLLAMA_API,
  44. AIOHTTP_CLIENT_TIMEOUT,
  45. ENABLE_MODEL_FILTER,
  46. MODEL_FILTER_LIST,
  47. UPLOAD_DIR,
  48. AppConfig,
  49. )
  50. from utils.misc import calculate_sha256, add_or_update_system_message
  51. log = logging.getLogger(__name__)
  52. log.setLevel(SRC_LOG_LEVELS["OLLAMA"])
  53. app = FastAPI()
  54. app.add_middleware(
  55. CORSMiddleware,
  56. allow_origins=["*"],
  57. allow_credentials=True,
  58. allow_methods=["*"],
  59. allow_headers=["*"],
  60. )
  61. app.state.config = AppConfig()
  62. app.state.config.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
  63. app.state.config.MODEL_FILTER_LIST = MODEL_FILTER_LIST
  64. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  65. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  66. app.state.MODELS = {}
  67. # TODO: Implement a more intelligent load balancing mechanism for distributing requests among multiple backend instances.
  68. # Current implementation uses a simple round-robin approach (random.choice). Consider incorporating algorithms like weighted round-robin,
  69. # least connections, or least response time for better resource utilization and performance optimization.
  70. @app.middleware("http")
  71. async def check_url(request: Request, call_next):
  72. if len(app.state.MODELS) == 0:
  73. await get_all_models()
  74. else:
  75. pass
  76. response = await call_next(request)
  77. return response
  78. @app.head("/")
  79. @app.get("/")
  80. async def get_status():
  81. return {"status": True}
  82. @app.get("/config")
  83. async def get_config(user=Depends(get_admin_user)):
  84. return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}
  85. class OllamaConfigForm(BaseModel):
  86. enable_ollama_api: Optional[bool] = None
  87. @app.post("/config/update")
  88. async def update_config(form_data: OllamaConfigForm, user=Depends(get_admin_user)):
  89. app.state.config.ENABLE_OLLAMA_API = form_data.enable_ollama_api
  90. return {"ENABLE_OLLAMA_API": app.state.config.ENABLE_OLLAMA_API}
  91. @app.get("/urls")
  92. async def get_ollama_api_urls(user=Depends(get_admin_user)):
  93. return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
  94. class UrlUpdateForm(BaseModel):
  95. urls: List[str]
  96. @app.post("/urls/update")
  97. async def update_ollama_api_url(form_data: UrlUpdateForm, user=Depends(get_admin_user)):
  98. app.state.config.OLLAMA_BASE_URLS = form_data.urls
  99. log.info(f"app.state.config.OLLAMA_BASE_URLS: {app.state.config.OLLAMA_BASE_URLS}")
  100. return {"OLLAMA_BASE_URLS": app.state.config.OLLAMA_BASE_URLS}
  101. async def fetch_url(url):
  102. timeout = aiohttp.ClientTimeout(total=5)
  103. try:
  104. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  105. async with session.get(url) as response:
  106. return await response.json()
  107. except Exception as e:
  108. # Handle connection error here
  109. log.error(f"Connection error: {e}")
  110. return None
  111. async def cleanup_response(
  112. response: Optional[aiohttp.ClientResponse],
  113. session: Optional[aiohttp.ClientSession],
  114. ):
  115. if response:
  116. response.close()
  117. if session:
  118. await session.close()
  119. async def post_streaming_url(url: str, payload: str):
  120. r = None
  121. try:
  122. session = aiohttp.ClientSession(
  123. trust_env=True, timeout=aiohttp.ClientTimeout(total=AIOHTTP_CLIENT_TIMEOUT)
  124. )
  125. r = await session.post(url, data=payload)
  126. r.raise_for_status()
  127. return StreamingResponse(
  128. r.content,
  129. status_code=r.status,
  130. headers=dict(r.headers),
  131. background=BackgroundTask(cleanup_response, response=r, session=session),
  132. )
  133. except Exception as e:
  134. error_detail = "Open WebUI: Server Connection Error"
  135. if r is not None:
  136. try:
  137. res = await r.json()
  138. if "error" in res:
  139. error_detail = f"Ollama: {res['error']}"
  140. except:
  141. error_detail = f"Ollama: {e}"
  142. raise HTTPException(
  143. status_code=r.status if r else 500,
  144. detail=error_detail,
  145. )
  146. def merge_models_lists(model_lists):
  147. merged_models = {}
  148. for idx, model_list in enumerate(model_lists):
  149. if model_list is not None:
  150. for model in model_list:
  151. digest = model["digest"]
  152. if digest not in merged_models:
  153. model["urls"] = [idx]
  154. merged_models[digest] = model
  155. else:
  156. merged_models[digest]["urls"].append(idx)
  157. return list(merged_models.values())
  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("num_batch", None):
  603. payload["options"]["num_batch"] = model_info.params.get(
  604. "num_batch", None
  605. )
  606. if model_info.params.get("num_keep", None):
  607. payload["options"]["num_keep"] = model_info.params.get("num_keep", None)
  608. if model_info.params.get("repeat_last_n", None):
  609. payload["options"]["repeat_last_n"] = model_info.params.get(
  610. "repeat_last_n", None
  611. )
  612. if model_info.params.get("frequency_penalty", None):
  613. payload["options"]["repeat_penalty"] = model_info.params.get(
  614. "frequency_penalty", None
  615. )
  616. if model_info.params.get("temperature", None) is not None:
  617. payload["options"]["temperature"] = model_info.params.get(
  618. "temperature", None
  619. )
  620. if model_info.params.get("seed", None):
  621. payload["options"]["seed"] = model_info.params.get("seed", None)
  622. if model_info.params.get("stop", None):
  623. payload["options"]["stop"] = (
  624. [
  625. bytes(stop, "utf-8").decode("unicode_escape")
  626. for stop in model_info.params["stop"]
  627. ]
  628. if model_info.params.get("stop", None)
  629. else None
  630. )
  631. if model_info.params.get("tfs_z", None):
  632. payload["options"]["tfs_z"] = model_info.params.get("tfs_z", None)
  633. if model_info.params.get("max_tokens", None):
  634. payload["options"]["num_predict"] = model_info.params.get(
  635. "max_tokens", None
  636. )
  637. if model_info.params.get("top_k", None):
  638. payload["options"]["top_k"] = model_info.params.get("top_k", None)
  639. if model_info.params.get("top_p", None):
  640. payload["options"]["top_p"] = model_info.params.get("top_p", None)
  641. if model_info.params.get("use_mmap", None):
  642. payload["options"]["use_mmap"] = model_info.params.get("use_mmap", None)
  643. if model_info.params.get("use_mlock", None):
  644. payload["options"]["use_mlock"] = model_info.params.get(
  645. "use_mlock", None
  646. )
  647. if model_info.params.get("num_thread", None):
  648. payload["options"]["num_thread"] = model_info.params.get(
  649. "num_thread", None
  650. )
  651. system = model_info.params.get("system", None)
  652. if system:
  653. # Check if the payload already has a system message
  654. # If not, add a system message to the payload
  655. system = prompt_template(
  656. system,
  657. **(
  658. {
  659. "user_name": user.name,
  660. "user_location": (
  661. user.info.get("location") if user.info else None
  662. ),
  663. }
  664. if user
  665. else {}
  666. ),
  667. )
  668. if payload.get("messages"):
  669. payload["messages"] = add_or_update_system_message(
  670. system, payload["messages"]
  671. )
  672. if url_idx == None:
  673. if ":" not in payload["model"]:
  674. payload["model"] = f"{payload['model']}:latest"
  675. if payload["model"] in app.state.MODELS:
  676. url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
  677. else:
  678. raise HTTPException(
  679. status_code=400,
  680. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  681. )
  682. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  683. log.info(f"url: {url}")
  684. log.debug(payload)
  685. return await post_streaming_url(f"{url}/api/chat", json.dumps(payload))
  686. # TODO: we should update this part once Ollama supports other types
  687. class OpenAIChatMessageContent(BaseModel):
  688. type: str
  689. model_config = ConfigDict(extra="allow")
  690. class OpenAIChatMessage(BaseModel):
  691. role: str
  692. content: Union[str, OpenAIChatMessageContent]
  693. model_config = ConfigDict(extra="allow")
  694. class OpenAIChatCompletionForm(BaseModel):
  695. model: str
  696. messages: List[OpenAIChatMessage]
  697. model_config = ConfigDict(extra="allow")
  698. @app.post("/v1/chat/completions")
  699. @app.post("/v1/chat/completions/{url_idx}")
  700. async def generate_openai_chat_completion(
  701. form_data: dict,
  702. url_idx: Optional[int] = None,
  703. user=Depends(get_verified_user),
  704. ):
  705. form_data = OpenAIChatCompletionForm(**form_data)
  706. payload = {
  707. **form_data.model_dump(exclude_none=True),
  708. }
  709. model_id = form_data.model
  710. model_info = Models.get_model_by_id(model_id)
  711. if model_info:
  712. if model_info.base_model_id:
  713. payload["model"] = model_info.base_model_id
  714. model_info.params = model_info.params.model_dump()
  715. if model_info.params:
  716. payload["temperature"] = model_info.params.get("temperature", None)
  717. payload["top_p"] = model_info.params.get("top_p", None)
  718. payload["max_tokens"] = model_info.params.get("max_tokens", None)
  719. payload["frequency_penalty"] = model_info.params.get(
  720. "frequency_penalty", None
  721. )
  722. payload["seed"] = model_info.params.get("seed", None)
  723. payload["stop"] = (
  724. [
  725. bytes(stop, "utf-8").decode("unicode_escape")
  726. for stop in model_info.params["stop"]
  727. ]
  728. if model_info.params.get("stop", None)
  729. else None
  730. )
  731. system = model_info.params.get("system", None)
  732. if system:
  733. system = prompt_template(
  734. system,
  735. **(
  736. {
  737. "user_name": user.name,
  738. "user_location": (
  739. user.info.get("location") if user.info else None
  740. ),
  741. }
  742. if user
  743. else {}
  744. ),
  745. )
  746. # Check if the payload already has a system message
  747. # If not, add a system message to the payload
  748. if payload.get("messages"):
  749. for message in payload["messages"]:
  750. if message.get("role") == "system":
  751. message["content"] = system + message["content"]
  752. break
  753. else:
  754. payload["messages"].insert(
  755. 0,
  756. {
  757. "role": "system",
  758. "content": system,
  759. },
  760. )
  761. if url_idx == None:
  762. if ":" not in payload["model"]:
  763. payload["model"] = f"{payload['model']}:latest"
  764. if payload["model"] in app.state.MODELS:
  765. url_idx = random.choice(app.state.MODELS[payload["model"]]["urls"])
  766. else:
  767. raise HTTPException(
  768. status_code=400,
  769. detail=ERROR_MESSAGES.MODEL_NOT_FOUND(form_data.model),
  770. )
  771. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  772. log.info(f"url: {url}")
  773. return await post_streaming_url(f"{url}/v1/chat/completions", json.dumps(payload))
  774. @app.get("/v1/models")
  775. @app.get("/v1/models/{url_idx}")
  776. async def get_openai_models(
  777. url_idx: Optional[int] = None,
  778. user=Depends(get_verified_user),
  779. ):
  780. if url_idx == None:
  781. models = await get_all_models()
  782. if app.state.config.ENABLE_MODEL_FILTER:
  783. if user.role == "user":
  784. models["models"] = list(
  785. filter(
  786. lambda model: model["name"]
  787. in app.state.config.MODEL_FILTER_LIST,
  788. models["models"],
  789. )
  790. )
  791. return {
  792. "data": [
  793. {
  794. "id": model["model"],
  795. "object": "model",
  796. "created": int(time.time()),
  797. "owned_by": "openai",
  798. }
  799. for model in models["models"]
  800. ],
  801. "object": "list",
  802. }
  803. else:
  804. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  805. try:
  806. r = requests.request(method="GET", url=f"{url}/api/tags")
  807. r.raise_for_status()
  808. models = r.json()
  809. return {
  810. "data": [
  811. {
  812. "id": model["model"],
  813. "object": "model",
  814. "created": int(time.time()),
  815. "owned_by": "openai",
  816. }
  817. for model in models["models"]
  818. ],
  819. "object": "list",
  820. }
  821. except Exception as e:
  822. log.exception(e)
  823. error_detail = "Open WebUI: Server Connection Error"
  824. if r is not None:
  825. try:
  826. res = r.json()
  827. if "error" in res:
  828. error_detail = f"Ollama: {res['error']}"
  829. except:
  830. error_detail = f"Ollama: {e}"
  831. raise HTTPException(
  832. status_code=r.status_code if r else 500,
  833. detail=error_detail,
  834. )
  835. class UrlForm(BaseModel):
  836. url: str
  837. class UploadBlobForm(BaseModel):
  838. filename: str
  839. def parse_huggingface_url(hf_url):
  840. try:
  841. # Parse the URL
  842. parsed_url = urlparse(hf_url)
  843. # Get the path and split it into components
  844. path_components = parsed_url.path.split("/")
  845. # Extract the desired output
  846. user_repo = "/".join(path_components[1:3])
  847. model_file = path_components[-1]
  848. return model_file
  849. except ValueError:
  850. return None
  851. async def download_file_stream(
  852. ollama_url, file_url, file_path, file_name, chunk_size=1024 * 1024
  853. ):
  854. done = False
  855. if os.path.exists(file_path):
  856. current_size = os.path.getsize(file_path)
  857. else:
  858. current_size = 0
  859. headers = {"Range": f"bytes={current_size}-"} if current_size > 0 else {}
  860. timeout = aiohttp.ClientTimeout(total=600) # Set the timeout
  861. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  862. async with session.get(file_url, headers=headers) as response:
  863. total_size = int(response.headers.get("content-length", 0)) + current_size
  864. with open(file_path, "ab+") as file:
  865. async for data in response.content.iter_chunked(chunk_size):
  866. current_size += len(data)
  867. file.write(data)
  868. done = current_size == total_size
  869. progress = round((current_size / total_size) * 100, 2)
  870. yield f'data: {{"progress": {progress}, "completed": {current_size}, "total": {total_size}}}\n\n'
  871. if done:
  872. file.seek(0)
  873. hashed = calculate_sha256(file)
  874. file.seek(0)
  875. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  876. response = requests.post(url, data=file)
  877. if response.ok:
  878. res = {
  879. "done": done,
  880. "blob": f"sha256:{hashed}",
  881. "name": file_name,
  882. }
  883. os.remove(file_path)
  884. yield f"data: {json.dumps(res)}\n\n"
  885. else:
  886. raise "Ollama: Could not create blob, Please try again."
  887. # url = "https://huggingface.co/TheBloke/stablelm-zephyr-3b-GGUF/resolve/main/stablelm-zephyr-3b.Q2_K.gguf"
  888. @app.post("/models/download")
  889. @app.post("/models/download/{url_idx}")
  890. async def download_model(
  891. form_data: UrlForm,
  892. url_idx: Optional[int] = None,
  893. user=Depends(get_admin_user),
  894. ):
  895. allowed_hosts = ["https://huggingface.co/", "https://github.com/"]
  896. if not any(form_data.url.startswith(host) for host in allowed_hosts):
  897. raise HTTPException(
  898. status_code=400,
  899. detail="Invalid file_url. Only URLs from allowed hosts are permitted.",
  900. )
  901. if url_idx == None:
  902. url_idx = 0
  903. url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  904. file_name = parse_huggingface_url(form_data.url)
  905. if file_name:
  906. file_path = f"{UPLOAD_DIR}/{file_name}"
  907. return StreamingResponse(
  908. download_file_stream(url, form_data.url, file_path, file_name),
  909. )
  910. else:
  911. return None
  912. @app.post("/models/upload")
  913. @app.post("/models/upload/{url_idx}")
  914. def upload_model(
  915. file: UploadFile = File(...),
  916. url_idx: Optional[int] = None,
  917. user=Depends(get_admin_user),
  918. ):
  919. if url_idx == None:
  920. url_idx = 0
  921. ollama_url = app.state.config.OLLAMA_BASE_URLS[url_idx]
  922. file_path = f"{UPLOAD_DIR}/{file.filename}"
  923. # Save file in chunks
  924. with open(file_path, "wb+") as f:
  925. for chunk in file.file:
  926. f.write(chunk)
  927. def file_process_stream():
  928. nonlocal ollama_url
  929. total_size = os.path.getsize(file_path)
  930. chunk_size = 1024 * 1024
  931. try:
  932. with open(file_path, "rb") as f:
  933. total = 0
  934. done = False
  935. while not done:
  936. chunk = f.read(chunk_size)
  937. if not chunk:
  938. done = True
  939. continue
  940. total += len(chunk)
  941. progress = round((total / total_size) * 100, 2)
  942. res = {
  943. "progress": progress,
  944. "total": total_size,
  945. "completed": total,
  946. }
  947. yield f"data: {json.dumps(res)}\n\n"
  948. if done:
  949. f.seek(0)
  950. hashed = calculate_sha256(f)
  951. f.seek(0)
  952. url = f"{ollama_url}/api/blobs/sha256:{hashed}"
  953. response = requests.post(url, data=f)
  954. if response.ok:
  955. res = {
  956. "done": done,
  957. "blob": f"sha256:{hashed}",
  958. "name": file.filename,
  959. }
  960. os.remove(file_path)
  961. yield f"data: {json.dumps(res)}\n\n"
  962. else:
  963. raise Exception(
  964. "Ollama: Could not create blob, Please try again."
  965. )
  966. except Exception as e:
  967. res = {"error": str(e)}
  968. yield f"data: {json.dumps(res)}\n\n"
  969. return StreamingResponse(file_process_stream(), media_type="text/event-stream")