main.py 36 KB

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