main.py 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350
  1. import base64
  2. import inspect
  3. import json
  4. import logging
  5. import mimetypes
  6. import os
  7. import shutil
  8. import sys
  9. import time
  10. import uuid
  11. from contextlib import asynccontextmanager
  12. from typing import Optional
  13. import aiohttp
  14. import requests
  15. from open_webui.apps.audio.main import app as audio_app
  16. from open_webui.apps.images.main import app as images_app
  17. from open_webui.apps.ollama.main import app as ollama_app
  18. from open_webui.apps.ollama.main import (
  19. generate_openai_chat_completion as generate_ollama_chat_completion,
  20. )
  21. from open_webui.apps.ollama.main import get_all_models as get_ollama_models
  22. from open_webui.apps.openai.main import app as openai_app
  23. from open_webui.apps.openai.main import (
  24. generate_chat_completion as generate_openai_chat_completion,
  25. )
  26. from open_webui.apps.openai.main import get_all_models as get_openai_models
  27. from open_webui.apps.rag.main import app as rag_app
  28. from open_webui.apps.rag.utils import get_rag_context, rag_template
  29. from open_webui.apps.socket.main import app as socket_app
  30. from open_webui.apps.socket.main import get_event_call, get_event_emitter
  31. from open_webui.apps.webui.internal.db import Session
  32. from open_webui.apps.webui.main import app as webui_app
  33. from open_webui.apps.webui.main import (
  34. generate_function_chat_completion,
  35. get_pipe_models,
  36. )
  37. from open_webui.apps.webui.models.auths import Auths
  38. from open_webui.apps.webui.models.functions import Functions
  39. from open_webui.apps.webui.models.models import Models
  40. from open_webui.apps.webui.models.users import UserModel, Users
  41. from open_webui.apps.webui.utils import load_function_module_by_id
  42. from authlib.integrations.starlette_client import OAuth
  43. from authlib.oidc.core import UserInfo
  44. from open_webui.config import (
  45. CACHE_DIR,
  46. CORS_ALLOW_ORIGIN,
  47. DEFAULT_LOCALE,
  48. ENABLE_ADMIN_CHAT_ACCESS,
  49. ENABLE_ADMIN_EXPORT,
  50. ENABLE_MODEL_FILTER,
  51. ENABLE_OAUTH_SIGNUP,
  52. ENABLE_OLLAMA_API,
  53. ENABLE_OPENAI_API,
  54. ENV,
  55. FRONTEND_BUILD_DIR,
  56. MODEL_FILTER_LIST,
  57. OAUTH_MERGE_ACCOUNTS_BY_EMAIL,
  58. OAUTH_PROVIDERS,
  59. ENABLE_SEARCH_QUERY,
  60. SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE,
  61. STATIC_DIR,
  62. TASK_MODEL,
  63. TASK_MODEL_EXTERNAL,
  64. TITLE_GENERATION_PROMPT_TEMPLATE,
  65. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  66. WEBHOOK_URL,
  67. WEBUI_AUTH,
  68. WEBUI_NAME,
  69. AppConfig,
  70. run_migrations,
  71. )
  72. from open_webui.constants import ERROR_MESSAGES, TASKS, WEBHOOK_MESSAGES
  73. from open_webui.env import (
  74. CHANGELOG,
  75. GLOBAL_LOG_LEVEL,
  76. SAFE_MODE,
  77. SRC_LOG_LEVELS,
  78. VERSION,
  79. WEBUI_BUILD_HASH,
  80. WEBUI_SECRET_KEY,
  81. WEBUI_SESSION_COOKIE_SAME_SITE,
  82. WEBUI_SESSION_COOKIE_SECURE,
  83. WEBUI_URL,
  84. )
  85. from fastapi import (
  86. Depends,
  87. FastAPI,
  88. File,
  89. Form,
  90. HTTPException,
  91. Request,
  92. UploadFile,
  93. status,
  94. )
  95. from fastapi.middleware.cors import CORSMiddleware
  96. from fastapi.responses import JSONResponse
  97. from fastapi.staticfiles import StaticFiles
  98. from pydantic import BaseModel
  99. from sqlalchemy import text
  100. from starlette.exceptions import HTTPException as StarletteHTTPException
  101. from starlette.middleware.base import BaseHTTPMiddleware
  102. from starlette.middleware.sessions import SessionMiddleware
  103. from starlette.responses import RedirectResponse, Response, StreamingResponse
  104. from open_webui.utils.misc import (
  105. add_or_update_system_message,
  106. get_last_user_message,
  107. parse_duration,
  108. prepend_to_first_user_message_content,
  109. )
  110. from open_webui.utils.task import (
  111. moa_response_generation_template,
  112. search_query_generation_template,
  113. title_generation_template,
  114. tools_function_calling_generation_template,
  115. )
  116. from open_webui.utils.tools import get_tools
  117. from open_webui.utils.utils import (
  118. create_token,
  119. decode_token,
  120. get_admin_user,
  121. get_current_user,
  122. get_http_authorization_cred,
  123. get_password_hash,
  124. get_verified_user,
  125. )
  126. from open_webui.utils.webhook import post_webhook
  127. if SAFE_MODE:
  128. print("SAFE MODE ENABLED")
  129. Functions.deactivate_all_functions()
  130. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  131. log = logging.getLogger(__name__)
  132. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  133. class SPAStaticFiles(StaticFiles):
  134. async def get_response(self, path: str, scope):
  135. try:
  136. return await super().get_response(path, scope)
  137. except (HTTPException, StarletteHTTPException) as ex:
  138. if ex.status_code == 404:
  139. return await super().get_response("index.html", scope)
  140. else:
  141. raise ex
  142. print(
  143. rf"""
  144. ___ __ __ _ _ _ ___
  145. / _ \ _ __ ___ _ __ \ \ / /__| |__ | | | |_ _|
  146. | | | | '_ \ / _ \ '_ \ \ \ /\ / / _ \ '_ \| | | || |
  147. | |_| | |_) | __/ | | | \ V V / __/ |_) | |_| || |
  148. \___/| .__/ \___|_| |_| \_/\_/ \___|_.__/ \___/|___|
  149. |_|
  150. v{VERSION} - building the best open-source AI user interface.
  151. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  152. https://github.com/open-webui/open-webui
  153. """
  154. )
  155. @asynccontextmanager
  156. async def lifespan(app: FastAPI):
  157. run_migrations()
  158. yield
  159. app = FastAPI(
  160. docs_url="/docs" if ENV == "dev" else None, redoc_url=None, lifespan=lifespan
  161. )
  162. app.state.config = AppConfig()
  163. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  164. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  165. app.state.config.ENABLE_MODEL_FILTER = ENABLE_MODEL_FILTER
  166. app.state.config.MODEL_FILTER_LIST = MODEL_FILTER_LIST
  167. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  168. app.state.config.TASK_MODEL = TASK_MODEL
  169. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  170. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  171. app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = (
  172. SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE
  173. )
  174. app.state.config.ENABLE_SEARCH_QUERY = ENABLE_SEARCH_QUERY
  175. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  176. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  177. )
  178. app.state.MODELS = {}
  179. ##################################
  180. #
  181. # ChatCompletion Middleware
  182. #
  183. ##################################
  184. def get_task_model_id(default_model_id):
  185. # Set the task model
  186. task_model_id = default_model_id
  187. # Check if the user has a custom task model and use that model
  188. if app.state.MODELS[task_model_id]["owned_by"] == "ollama":
  189. if (
  190. app.state.config.TASK_MODEL
  191. and app.state.config.TASK_MODEL in app.state.MODELS
  192. ):
  193. task_model_id = app.state.config.TASK_MODEL
  194. else:
  195. if (
  196. app.state.config.TASK_MODEL_EXTERNAL
  197. and app.state.config.TASK_MODEL_EXTERNAL in app.state.MODELS
  198. ):
  199. task_model_id = app.state.config.TASK_MODEL_EXTERNAL
  200. return task_model_id
  201. def get_filter_function_ids(model):
  202. def get_priority(function_id):
  203. function = Functions.get_function_by_id(function_id)
  204. if function is not None and hasattr(function, "valves"):
  205. # TODO: Fix FunctionModel
  206. return (function.valves if function.valves else {}).get("priority", 0)
  207. return 0
  208. filter_ids = [function.id for function in Functions.get_global_filter_functions()]
  209. if "info" in model and "meta" in model["info"]:
  210. filter_ids.extend(model["info"]["meta"].get("filterIds", []))
  211. filter_ids = list(set(filter_ids))
  212. enabled_filter_ids = [
  213. function.id
  214. for function in Functions.get_functions_by_type("filter", active_only=True)
  215. ]
  216. filter_ids = [
  217. filter_id for filter_id in filter_ids if filter_id in enabled_filter_ids
  218. ]
  219. filter_ids.sort(key=get_priority)
  220. return filter_ids
  221. async def chat_completion_filter_functions_handler(body, model, extra_params):
  222. skip_files = None
  223. filter_ids = get_filter_function_ids(model)
  224. for filter_id in filter_ids:
  225. filter = Functions.get_function_by_id(filter_id)
  226. if not filter:
  227. continue
  228. if filter_id in webui_app.state.FUNCTIONS:
  229. function_module = webui_app.state.FUNCTIONS[filter_id]
  230. else:
  231. function_module, _, _ = load_function_module_by_id(filter_id)
  232. webui_app.state.FUNCTIONS[filter_id] = function_module
  233. # Check if the function has a file_handler variable
  234. if hasattr(function_module, "file_handler"):
  235. skip_files = function_module.file_handler
  236. if hasattr(function_module, "valves") and hasattr(function_module, "Valves"):
  237. valves = Functions.get_function_valves_by_id(filter_id)
  238. function_module.valves = function_module.Valves(
  239. **(valves if valves else {})
  240. )
  241. if not hasattr(function_module, "inlet"):
  242. continue
  243. try:
  244. inlet = function_module.inlet
  245. # Get the signature of the function
  246. sig = inspect.signature(inlet)
  247. params = {"body": body} | {
  248. k: v
  249. for k, v in {
  250. **extra_params,
  251. "__model__": model,
  252. "__id__": filter_id,
  253. }.items()
  254. if k in sig.parameters
  255. }
  256. if "__user__" in params and hasattr(function_module, "UserValves"):
  257. try:
  258. params["__user__"]["valves"] = function_module.UserValves(
  259. **Functions.get_user_valves_by_id_and_user_id(
  260. filter_id, params["__user__"]["id"]
  261. )
  262. )
  263. except Exception as e:
  264. print(e)
  265. if inspect.iscoroutinefunction(inlet):
  266. body = await inlet(**params)
  267. else:
  268. body = inlet(**params)
  269. except Exception as e:
  270. print(f"Error: {e}")
  271. raise e
  272. if skip_files and "files" in body.get("metadata", {}):
  273. del body["metadata"]["files"]
  274. return body, {}
  275. def get_tools_function_calling_payload(messages, task_model_id, content):
  276. user_message = get_last_user_message(messages)
  277. history = "\n".join(
  278. f"{message['role'].upper()}: \"\"\"{message['content']}\"\"\""
  279. for message in messages[::-1][:4]
  280. )
  281. prompt = f"History:\n{history}\nQuery: {user_message}"
  282. return {
  283. "model": task_model_id,
  284. "messages": [
  285. {"role": "system", "content": content},
  286. {"role": "user", "content": f"Query: {prompt}"},
  287. ],
  288. "stream": False,
  289. "metadata": {"task": str(TASKS.FUNCTION_CALLING)},
  290. }
  291. async def get_content_from_response(response) -> Optional[str]:
  292. content = None
  293. if hasattr(response, "body_iterator"):
  294. async for chunk in response.body_iterator:
  295. data = json.loads(chunk.decode("utf-8"))
  296. content = data["choices"][0]["message"]["content"]
  297. # Cleanup any remaining background tasks if necessary
  298. if response.background is not None:
  299. await response.background()
  300. else:
  301. content = response["choices"][0]["message"]["content"]
  302. return content
  303. async def chat_completion_tools_handler(
  304. body: dict, user: UserModel, extra_params: dict
  305. ) -> tuple[dict, dict]:
  306. # If tool_ids field is present, call the functions
  307. metadata = body.get("metadata", {})
  308. tool_ids = metadata.get("tool_ids", None)
  309. log.debug(f"{tool_ids=}")
  310. if not tool_ids:
  311. return body, {}
  312. skip_files = False
  313. contexts = []
  314. citations = []
  315. task_model_id = get_task_model_id(body["model"])
  316. tools = get_tools(
  317. webui_app,
  318. tool_ids,
  319. user,
  320. {
  321. **extra_params,
  322. "__model__": app.state.MODELS[task_model_id],
  323. "__messages__": body["messages"],
  324. "__files__": metadata.get("files", []),
  325. },
  326. )
  327. log.info(f"{tools=}")
  328. specs = [tool["spec"] for tool in tools.values()]
  329. tools_specs = json.dumps(specs)
  330. if app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE != "":
  331. template = app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  332. else:
  333. template = """Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query. If a function tool matches, construct and return a JSON object in the format {\"name\": \"functionName\", \"parameters\": {\"requiredFunctionParamKey\": \"requiredFunctionParamValue\"}} using the appropriate tool and its parameters. Only return the object and limit the response to the JSON object without additional text."""
  334. tools_function_calling_prompt = tools_function_calling_generation_template(
  335. template, tools_specs
  336. )
  337. log.info(f"{tools_function_calling_prompt=}")
  338. payload = get_tools_function_calling_payload(
  339. body["messages"], task_model_id, tools_function_calling_prompt
  340. )
  341. try:
  342. payload = filter_pipeline(payload, user)
  343. except Exception as e:
  344. raise e
  345. try:
  346. response = await generate_chat_completions(form_data=payload, user=user)
  347. log.debug(f"{response=}")
  348. content = await get_content_from_response(response)
  349. log.debug(f"{content=}")
  350. if not content:
  351. return body, {}
  352. result = json.loads(content)
  353. tool_function_name = result.get("name", None)
  354. if tool_function_name not in tools:
  355. return body, {}
  356. tool_function_params = result.get("parameters", {})
  357. try:
  358. tool_output = await tools[tool_function_name]["callable"](
  359. **tool_function_params
  360. )
  361. except Exception as e:
  362. tool_output = str(e)
  363. if tools[tool_function_name]["citation"]:
  364. citations.append(
  365. {
  366. "source": {
  367. "name": f"TOOL:{tools[tool_function_name]['toolkit_id']}/{tool_function_name}"
  368. },
  369. "document": [tool_output],
  370. "metadata": [{"source": tool_function_name}],
  371. }
  372. )
  373. if tools[tool_function_name]["file_handler"]:
  374. skip_files = True
  375. if isinstance(tool_output, str):
  376. contexts.append(tool_output)
  377. except Exception as e:
  378. log.exception(f"Error: {e}")
  379. content = None
  380. log.debug(f"tool_contexts: {contexts}")
  381. if skip_files and "files" in body.get("metadata", {}):
  382. del body["metadata"]["files"]
  383. return body, {"contexts": contexts, "citations": citations}
  384. async def chat_completion_files_handler(body) -> tuple[dict, dict[str, list]]:
  385. contexts = []
  386. citations = []
  387. if files := body.get("metadata", {}).get("files", None):
  388. contexts, citations = get_rag_context(
  389. files=files,
  390. messages=body["messages"],
  391. embedding_function=rag_app.state.EMBEDDING_FUNCTION,
  392. k=rag_app.state.config.TOP_K,
  393. reranking_function=rag_app.state.sentence_transformer_rf,
  394. r=rag_app.state.config.RELEVANCE_THRESHOLD,
  395. hybrid_search=rag_app.state.config.ENABLE_RAG_HYBRID_SEARCH,
  396. )
  397. log.debug(f"rag_contexts: {contexts}, citations: {citations}")
  398. return body, {"contexts": contexts, "citations": citations}
  399. def is_chat_completion_request(request):
  400. return request.method == "POST" and any(
  401. endpoint in request.url.path
  402. for endpoint in ["/ollama/api/chat", "/chat/completions"]
  403. )
  404. async def get_body_and_model_and_user(request):
  405. # Read the original request body
  406. body = await request.body()
  407. body_str = body.decode("utf-8")
  408. body = json.loads(body_str) if body_str else {}
  409. model_id = body["model"]
  410. if model_id not in app.state.MODELS:
  411. raise Exception("Model not found")
  412. model = app.state.MODELS[model_id]
  413. user = get_current_user(
  414. request,
  415. get_http_authorization_cred(request.headers.get("Authorization")),
  416. )
  417. return body, model, user
  418. class ChatCompletionMiddleware(BaseHTTPMiddleware):
  419. async def dispatch(self, request: Request, call_next):
  420. if not is_chat_completion_request(request):
  421. return await call_next(request)
  422. log.debug(f"request.url.path: {request.url.path}")
  423. try:
  424. body, model, user = await get_body_and_model_and_user(request)
  425. except Exception as e:
  426. return JSONResponse(
  427. status_code=status.HTTP_400_BAD_REQUEST,
  428. content={"detail": str(e)},
  429. )
  430. metadata = {
  431. "chat_id": body.pop("chat_id", None),
  432. "message_id": body.pop("id", None),
  433. "session_id": body.pop("session_id", None),
  434. "tool_ids": body.get("tool_ids", None),
  435. "files": body.get("files", None),
  436. }
  437. body["metadata"] = metadata
  438. extra_params = {
  439. "__event_emitter__": get_event_emitter(metadata),
  440. "__event_call__": get_event_call(metadata),
  441. "__user__": {
  442. "id": user.id,
  443. "email": user.email,
  444. "name": user.name,
  445. "role": user.role,
  446. },
  447. }
  448. # Initialize data_items to store additional data to be sent to the client
  449. # Initalize contexts and citation
  450. data_items = []
  451. contexts = []
  452. citations = []
  453. try:
  454. body, flags = await chat_completion_filter_functions_handler(
  455. body, model, extra_params
  456. )
  457. except Exception as e:
  458. return JSONResponse(
  459. status_code=status.HTTP_400_BAD_REQUEST,
  460. content={"detail": str(e)},
  461. )
  462. metadata = {
  463. **metadata,
  464. "tool_ids": body.pop("tool_ids", None),
  465. "files": body.pop("files", None),
  466. }
  467. body["metadata"] = metadata
  468. try:
  469. body, flags = await chat_completion_tools_handler(body, user, extra_params)
  470. contexts.extend(flags.get("contexts", []))
  471. citations.extend(flags.get("citations", []))
  472. except Exception as e:
  473. log.exception(e)
  474. try:
  475. body, flags = await chat_completion_files_handler(body)
  476. contexts.extend(flags.get("contexts", []))
  477. citations.extend(flags.get("citations", []))
  478. except Exception as e:
  479. log.exception(e)
  480. # If context is not empty, insert it into the messages
  481. if len(contexts) > 0:
  482. context_string = "/n".join(contexts).strip()
  483. prompt = get_last_user_message(body["messages"])
  484. if prompt is None:
  485. raise Exception("No user message found")
  486. if rag_app.state.config.RELEVANCE_THRESHOLD == 0:
  487. if context_string.strip() == "":
  488. log.debug(
  489. f"With a 0 relevancy threshold for RAG, the context cannot be empty"
  490. )
  491. # Workaround for Ollama 2.0+ system prompt issue
  492. # TODO: replace with add_or_update_system_message
  493. if model["owned_by"] == "ollama":
  494. body["messages"] = prepend_to_first_user_message_content(
  495. rag_template(
  496. rag_app.state.config.RAG_TEMPLATE, context_string, prompt
  497. ),
  498. body["messages"],
  499. )
  500. else:
  501. body["messages"] = add_or_update_system_message(
  502. rag_template(
  503. rag_app.state.config.RAG_TEMPLATE, context_string, prompt
  504. ),
  505. body["messages"],
  506. )
  507. # If there are citations, add them to the data_items
  508. if len(citations) > 0:
  509. data_items.append({"citations": citations})
  510. modified_body_bytes = json.dumps(body).encode("utf-8")
  511. # Replace the request body with the modified one
  512. request._body = modified_body_bytes
  513. # Set custom header to ensure content-length matches new body length
  514. request.headers.__dict__["_list"] = [
  515. (b"content-length", str(len(modified_body_bytes)).encode("utf-8")),
  516. *[(k, v) for k, v in request.headers.raw if k.lower() != b"content-length"],
  517. ]
  518. response = await call_next(request)
  519. if not isinstance(response, StreamingResponse):
  520. return response
  521. content_type = response.headers["Content-Type"]
  522. is_openai = "text/event-stream" in content_type
  523. is_ollama = "application/x-ndjson" in content_type
  524. if not is_openai and not is_ollama:
  525. return response
  526. def wrap_item(item):
  527. return f"data: {item}\n\n" if is_openai else f"{item}\n"
  528. async def stream_wrapper(original_generator, data_items):
  529. for item in data_items:
  530. yield wrap_item(json.dumps(item))
  531. async for data in original_generator:
  532. yield data
  533. return StreamingResponse(
  534. stream_wrapper(response.body_iterator, data_items),
  535. headers=dict(response.headers),
  536. )
  537. async def _receive(self, body: bytes):
  538. return {"type": "http.request", "body": body, "more_body": False}
  539. app.add_middleware(ChatCompletionMiddleware)
  540. ##################################
  541. #
  542. # Pipeline Middleware
  543. #
  544. ##################################
  545. def get_sorted_filters(model_id):
  546. filters = [
  547. model
  548. for model in app.state.MODELS.values()
  549. if "pipeline" in model
  550. and "type" in model["pipeline"]
  551. and model["pipeline"]["type"] == "filter"
  552. and (
  553. model["pipeline"]["pipelines"] == ["*"]
  554. or any(
  555. model_id == target_model_id
  556. for target_model_id in model["pipeline"]["pipelines"]
  557. )
  558. )
  559. ]
  560. sorted_filters = sorted(filters, key=lambda x: x["pipeline"]["priority"])
  561. return sorted_filters
  562. def filter_pipeline(payload, user):
  563. user = {"id": user.id, "email": user.email, "name": user.name, "role": user.role}
  564. model_id = payload["model"]
  565. sorted_filters = get_sorted_filters(model_id)
  566. model = app.state.MODELS[model_id]
  567. if "pipeline" in model:
  568. sorted_filters.append(model)
  569. for filter in sorted_filters:
  570. r = None
  571. try:
  572. urlIdx = filter["urlIdx"]
  573. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  574. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  575. if key == "":
  576. continue
  577. headers = {"Authorization": f"Bearer {key}"}
  578. r = requests.post(
  579. f"{url}/{filter['id']}/filter/inlet",
  580. headers=headers,
  581. json={
  582. "user": user,
  583. "body": payload,
  584. },
  585. )
  586. r.raise_for_status()
  587. payload = r.json()
  588. except Exception as e:
  589. # Handle connection error here
  590. print(f"Connection error: {e}")
  591. if r is not None:
  592. res = r.json()
  593. if "detail" in res:
  594. raise Exception(r.status_code, res["detail"])
  595. return payload
  596. class PipelineMiddleware(BaseHTTPMiddleware):
  597. async def dispatch(self, request: Request, call_next):
  598. if not is_chat_completion_request(request):
  599. return await call_next(request)
  600. log.debug(f"request.url.path: {request.url.path}")
  601. # Read the original request body
  602. body = await request.body()
  603. # Decode body to string
  604. body_str = body.decode("utf-8")
  605. # Parse string to JSON
  606. data = json.loads(body_str) if body_str else {}
  607. user = get_current_user(
  608. request,
  609. get_http_authorization_cred(request.headers["Authorization"]),
  610. )
  611. try:
  612. data = filter_pipeline(data, user)
  613. except Exception as e:
  614. if len(e.args) > 1:
  615. return JSONResponse(
  616. status_code=e.args[0],
  617. content={"detail": e.args[1]},
  618. )
  619. else:
  620. return JSONResponse(
  621. status_code=status.HTTP_400_BAD_REQUEST,
  622. content={"detail": str(e)},
  623. )
  624. modified_body_bytes = json.dumps(data).encode("utf-8")
  625. # Replace the request body with the modified one
  626. request._body = modified_body_bytes
  627. # Set custom header to ensure content-length matches new body length
  628. request.headers.__dict__["_list"] = [
  629. (b"content-length", str(len(modified_body_bytes)).encode("utf-8")),
  630. *[(k, v) for k, v in request.headers.raw if k.lower() != b"content-length"],
  631. ]
  632. response = await call_next(request)
  633. return response
  634. async def _receive(self, body: bytes):
  635. return {"type": "http.request", "body": body, "more_body": False}
  636. app.add_middleware(PipelineMiddleware)
  637. app.add_middleware(
  638. CORSMiddleware,
  639. allow_origins=CORS_ALLOW_ORIGIN,
  640. allow_credentials=True,
  641. allow_methods=["*"],
  642. allow_headers=["*"],
  643. )
  644. @app.middleware("http")
  645. async def commit_session_after_request(request: Request, call_next):
  646. response = await call_next(request)
  647. log.debug("Commit session after request")
  648. Session.commit()
  649. return response
  650. @app.middleware("http")
  651. async def check_url(request: Request, call_next):
  652. if len(app.state.MODELS) == 0:
  653. await get_all_models()
  654. else:
  655. pass
  656. start_time = int(time.time())
  657. response = await call_next(request)
  658. process_time = int(time.time()) - start_time
  659. response.headers["X-Process-Time"] = str(process_time)
  660. return response
  661. @app.middleware("http")
  662. async def update_embedding_function(request: Request, call_next):
  663. response = await call_next(request)
  664. if "/embedding/update" in request.url.path:
  665. webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION
  666. return response
  667. @app.middleware("http")
  668. async def inspect_websocket(request: Request, call_next):
  669. if (
  670. "/ws/socket.io" in request.url.path
  671. and request.query_params.get("transport") == "websocket"
  672. ):
  673. upgrade = (request.headers.get("Upgrade") or "").lower()
  674. connection = (request.headers.get("Connection") or "").lower().split(",")
  675. # Check that there's the correct headers for an upgrade, else reject the connection
  676. # This is to work around this upstream issue: https://github.com/miguelgrinberg/python-engineio/issues/367
  677. if upgrade != "websocket" or "upgrade" not in connection:
  678. return JSONResponse(
  679. status_code=status.HTTP_400_BAD_REQUEST,
  680. content={"detail": "Invalid WebSocket upgrade request"},
  681. )
  682. return await call_next(request)
  683. app.mount("/ws", socket_app)
  684. app.mount("/ollama", ollama_app)
  685. app.mount("/openai", openai_app)
  686. app.mount("/images/api/v1", images_app)
  687. app.mount("/audio/api/v1", audio_app)
  688. app.mount("/rag/api/v1", rag_app)
  689. app.mount("/api/v1", webui_app)
  690. webui_app.state.EMBEDDING_FUNCTION = rag_app.state.EMBEDDING_FUNCTION
  691. async def get_all_models():
  692. # TODO: Optimize this function
  693. pipe_models = []
  694. openai_models = []
  695. ollama_models = []
  696. pipe_models = await get_pipe_models()
  697. if app.state.config.ENABLE_OPENAI_API:
  698. openai_models = await get_openai_models()
  699. openai_models = openai_models["data"]
  700. if app.state.config.ENABLE_OLLAMA_API:
  701. ollama_models = await get_ollama_models()
  702. ollama_models = [
  703. {
  704. "id": model["model"],
  705. "name": model["name"],
  706. "object": "model",
  707. "created": int(time.time()),
  708. "owned_by": "ollama",
  709. "ollama": model,
  710. }
  711. for model in ollama_models["models"]
  712. ]
  713. models = pipe_models + openai_models + ollama_models
  714. global_action_ids = [
  715. function.id for function in Functions.get_global_action_functions()
  716. ]
  717. enabled_action_ids = [
  718. function.id
  719. for function in Functions.get_functions_by_type("action", active_only=True)
  720. ]
  721. custom_models = Models.get_all_models()
  722. for custom_model in custom_models:
  723. if custom_model.base_model_id is None:
  724. for model in models:
  725. if (
  726. custom_model.id == model["id"]
  727. or custom_model.id == model["id"].split(":")[0]
  728. ):
  729. model["name"] = custom_model.name
  730. model["info"] = custom_model.model_dump()
  731. action_ids = []
  732. if "info" in model and "meta" in model["info"]:
  733. action_ids.extend(model["info"]["meta"].get("actionIds", []))
  734. model["action_ids"] = action_ids
  735. else:
  736. owned_by = "openai"
  737. pipe = None
  738. action_ids = []
  739. for model in models:
  740. if (
  741. custom_model.base_model_id == model["id"]
  742. or custom_model.base_model_id == model["id"].split(":")[0]
  743. ):
  744. owned_by = model["owned_by"]
  745. if "pipe" in model:
  746. pipe = model["pipe"]
  747. if "info" in model and "meta" in model["info"]:
  748. action_ids.extend(model["info"]["meta"].get("actionIds", []))
  749. break
  750. models.append(
  751. {
  752. "id": custom_model.id,
  753. "name": custom_model.name,
  754. "object": "model",
  755. "created": custom_model.created_at,
  756. "owned_by": owned_by,
  757. "info": custom_model.model_dump(),
  758. "preset": True,
  759. **({"pipe": pipe} if pipe is not None else {}),
  760. "action_ids": action_ids,
  761. }
  762. )
  763. for model in models:
  764. action_ids = []
  765. if "action_ids" in model:
  766. action_ids = model["action_ids"]
  767. del model["action_ids"]
  768. action_ids = action_ids + global_action_ids
  769. action_ids = list(set(action_ids))
  770. action_ids = [
  771. action_id for action_id in action_ids if action_id in enabled_action_ids
  772. ]
  773. model["actions"] = []
  774. for action_id in action_ids:
  775. action = Functions.get_function_by_id(action_id)
  776. if action is None:
  777. raise Exception(f"Action not found: {action_id}")
  778. if action_id in webui_app.state.FUNCTIONS:
  779. function_module = webui_app.state.FUNCTIONS[action_id]
  780. else:
  781. function_module, _, _ = load_function_module_by_id(action_id)
  782. webui_app.state.FUNCTIONS[action_id] = function_module
  783. __webui__ = False
  784. if hasattr(function_module, "__webui__"):
  785. __webui__ = function_module.__webui__
  786. if hasattr(function_module, "actions"):
  787. actions = function_module.actions
  788. model["actions"].extend(
  789. [
  790. {
  791. "id": f"{action_id}.{_action['id']}",
  792. "name": _action.get(
  793. "name", f"{action.name} ({_action['id']})"
  794. ),
  795. "description": action.meta.description,
  796. "icon_url": _action.get(
  797. "icon_url", action.meta.manifest.get("icon_url", None)
  798. ),
  799. **({"__webui__": __webui__} if __webui__ else {}),
  800. }
  801. for _action in actions
  802. ]
  803. )
  804. else:
  805. model["actions"].append(
  806. {
  807. "id": action_id,
  808. "name": action.name,
  809. "description": action.meta.description,
  810. "icon_url": action.meta.manifest.get("icon_url", None),
  811. **({"__webui__": __webui__} if __webui__ else {}),
  812. }
  813. )
  814. app.state.MODELS = {model["id"]: model for model in models}
  815. webui_app.state.MODELS = app.state.MODELS
  816. return models
  817. @app.get("/api/models")
  818. async def get_models(user=Depends(get_verified_user)):
  819. models = await get_all_models()
  820. # Filter out filter pipelines
  821. models = [
  822. model
  823. for model in models
  824. if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
  825. ]
  826. if app.state.config.ENABLE_MODEL_FILTER:
  827. if user.role == "user":
  828. models = list(
  829. filter(
  830. lambda model: model["id"] in app.state.config.MODEL_FILTER_LIST,
  831. models,
  832. )
  833. )
  834. return {"data": models}
  835. return {"data": models}
  836. @app.post("/api/chat/completions")
  837. async def generate_chat_completions(form_data: dict, user=Depends(get_verified_user)):
  838. model_id = form_data["model"]
  839. if model_id not in app.state.MODELS:
  840. raise HTTPException(
  841. status_code=status.HTTP_404_NOT_FOUND,
  842. detail="Model not found",
  843. )
  844. if app.state.config.ENABLE_MODEL_FILTER:
  845. if user.role == "user" and model_id not in app.state.config.MODEL_FILTER_LIST:
  846. raise HTTPException(
  847. status_code=status.HTTP_403_FORBIDDEN,
  848. detail="Model not found",
  849. )
  850. model = app.state.MODELS[model_id]
  851. if model.get("pipe"):
  852. return await generate_function_chat_completion(form_data, user=user)
  853. if model["owned_by"] == "ollama":
  854. return await generate_ollama_chat_completion(form_data, user=user)
  855. else:
  856. return await generate_openai_chat_completion(form_data, user=user)
  857. @app.post("/api/chat/completed")
  858. async def chat_completed(form_data: dict, user=Depends(get_verified_user)):
  859. data = form_data
  860. model_id = data["model"]
  861. if model_id not in app.state.MODELS:
  862. raise HTTPException(
  863. status_code=status.HTTP_404_NOT_FOUND,
  864. detail="Model not found",
  865. )
  866. model = app.state.MODELS[model_id]
  867. sorted_filters = get_sorted_filters(model_id)
  868. if "pipeline" in model:
  869. sorted_filters = [model] + sorted_filters
  870. for filter in sorted_filters:
  871. r = None
  872. try:
  873. urlIdx = filter["urlIdx"]
  874. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  875. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  876. if key != "":
  877. headers = {"Authorization": f"Bearer {key}"}
  878. r = requests.post(
  879. f"{url}/{filter['id']}/filter/outlet",
  880. headers=headers,
  881. json={
  882. "user": {
  883. "id": user.id,
  884. "name": user.name,
  885. "email": user.email,
  886. "role": user.role,
  887. },
  888. "body": data,
  889. },
  890. )
  891. r.raise_for_status()
  892. data = r.json()
  893. except Exception as e:
  894. # Handle connection error here
  895. print(f"Connection error: {e}")
  896. if r is not None:
  897. try:
  898. res = r.json()
  899. if "detail" in res:
  900. return JSONResponse(
  901. status_code=r.status_code,
  902. content=res,
  903. )
  904. except Exception:
  905. pass
  906. else:
  907. pass
  908. __event_emitter__ = get_event_emitter(
  909. {
  910. "chat_id": data["chat_id"],
  911. "message_id": data["id"],
  912. "session_id": data["session_id"],
  913. }
  914. )
  915. __event_call__ = get_event_call(
  916. {
  917. "chat_id": data["chat_id"],
  918. "message_id": data["id"],
  919. "session_id": data["session_id"],
  920. }
  921. )
  922. def get_priority(function_id):
  923. function = Functions.get_function_by_id(function_id)
  924. if function is not None and hasattr(function, "valves"):
  925. # TODO: Fix FunctionModel to include vavles
  926. return (function.valves if function.valves else {}).get("priority", 0)
  927. return 0
  928. filter_ids = [function.id for function in Functions.get_global_filter_functions()]
  929. if "info" in model and "meta" in model["info"]:
  930. filter_ids.extend(model["info"]["meta"].get("filterIds", []))
  931. filter_ids = list(set(filter_ids))
  932. enabled_filter_ids = [
  933. function.id
  934. for function in Functions.get_functions_by_type("filter", active_only=True)
  935. ]
  936. filter_ids = [
  937. filter_id for filter_id in filter_ids if filter_id in enabled_filter_ids
  938. ]
  939. # Sort filter_ids by priority, using the get_priority function
  940. filter_ids.sort(key=get_priority)
  941. for filter_id in filter_ids:
  942. filter = Functions.get_function_by_id(filter_id)
  943. if not filter:
  944. continue
  945. if filter_id in webui_app.state.FUNCTIONS:
  946. function_module = webui_app.state.FUNCTIONS[filter_id]
  947. else:
  948. function_module, _, _ = load_function_module_by_id(filter_id)
  949. webui_app.state.FUNCTIONS[filter_id] = function_module
  950. if hasattr(function_module, "valves") and hasattr(function_module, "Valves"):
  951. valves = Functions.get_function_valves_by_id(filter_id)
  952. function_module.valves = function_module.Valves(
  953. **(valves if valves else {})
  954. )
  955. if not hasattr(function_module, "outlet"):
  956. continue
  957. try:
  958. outlet = function_module.outlet
  959. # Get the signature of the function
  960. sig = inspect.signature(outlet)
  961. params = {"body": data}
  962. # Extra parameters to be passed to the function
  963. extra_params = {
  964. "__model__": model,
  965. "__id__": filter_id,
  966. "__event_emitter__": __event_emitter__,
  967. "__event_call__": __event_call__,
  968. }
  969. # Add extra params in contained in function signature
  970. for key, value in extra_params.items():
  971. if key in sig.parameters:
  972. params[key] = value
  973. if "__user__" in sig.parameters:
  974. __user__ = {
  975. "id": user.id,
  976. "email": user.email,
  977. "name": user.name,
  978. "role": user.role,
  979. }
  980. try:
  981. if hasattr(function_module, "UserValves"):
  982. __user__["valves"] = function_module.UserValves(
  983. **Functions.get_user_valves_by_id_and_user_id(
  984. filter_id, user.id
  985. )
  986. )
  987. except Exception as e:
  988. print(e)
  989. params = {**params, "__user__": __user__}
  990. if inspect.iscoroutinefunction(outlet):
  991. data = await outlet(**params)
  992. else:
  993. data = outlet(**params)
  994. except Exception as e:
  995. print(f"Error: {e}")
  996. return JSONResponse(
  997. status_code=status.HTTP_400_BAD_REQUEST,
  998. content={"detail": str(e)},
  999. )
  1000. return data
  1001. @app.post("/api/chat/actions/{action_id}")
  1002. async def chat_action(action_id: str, form_data: dict, user=Depends(get_verified_user)):
  1003. if "." in action_id:
  1004. action_id, sub_action_id = action_id.split(".")
  1005. else:
  1006. sub_action_id = None
  1007. action = Functions.get_function_by_id(action_id)
  1008. if not action:
  1009. raise HTTPException(
  1010. status_code=status.HTTP_404_NOT_FOUND,
  1011. detail="Action not found",
  1012. )
  1013. data = form_data
  1014. model_id = data["model"]
  1015. if model_id not in app.state.MODELS:
  1016. raise HTTPException(
  1017. status_code=status.HTTP_404_NOT_FOUND,
  1018. detail="Model not found",
  1019. )
  1020. model = app.state.MODELS[model_id]
  1021. __event_emitter__ = get_event_emitter(
  1022. {
  1023. "chat_id": data["chat_id"],
  1024. "message_id": data["id"],
  1025. "session_id": data["session_id"],
  1026. }
  1027. )
  1028. __event_call__ = get_event_call(
  1029. {
  1030. "chat_id": data["chat_id"],
  1031. "message_id": data["id"],
  1032. "session_id": data["session_id"],
  1033. }
  1034. )
  1035. if action_id in webui_app.state.FUNCTIONS:
  1036. function_module = webui_app.state.FUNCTIONS[action_id]
  1037. else:
  1038. function_module, _, _ = load_function_module_by_id(action_id)
  1039. webui_app.state.FUNCTIONS[action_id] = function_module
  1040. if hasattr(function_module, "valves") and hasattr(function_module, "Valves"):
  1041. valves = Functions.get_function_valves_by_id(action_id)
  1042. function_module.valves = function_module.Valves(**(valves if valves else {}))
  1043. if hasattr(function_module, "action"):
  1044. try:
  1045. action = function_module.action
  1046. # Get the signature of the function
  1047. sig = inspect.signature(action)
  1048. params = {"body": data}
  1049. # Extra parameters to be passed to the function
  1050. extra_params = {
  1051. "__model__": model,
  1052. "__id__": sub_action_id if sub_action_id is not None else action_id,
  1053. "__event_emitter__": __event_emitter__,
  1054. "__event_call__": __event_call__,
  1055. }
  1056. # Add extra params in contained in function signature
  1057. for key, value in extra_params.items():
  1058. if key in sig.parameters:
  1059. params[key] = value
  1060. if "__user__" in sig.parameters:
  1061. __user__ = {
  1062. "id": user.id,
  1063. "email": user.email,
  1064. "name": user.name,
  1065. "role": user.role,
  1066. }
  1067. try:
  1068. if hasattr(function_module, "UserValves"):
  1069. __user__["valves"] = function_module.UserValves(
  1070. **Functions.get_user_valves_by_id_and_user_id(
  1071. action_id, user.id
  1072. )
  1073. )
  1074. except Exception as e:
  1075. print(e)
  1076. params = {**params, "__user__": __user__}
  1077. if inspect.iscoroutinefunction(action):
  1078. data = await action(**params)
  1079. else:
  1080. data = action(**params)
  1081. except Exception as e:
  1082. print(f"Error: {e}")
  1083. return JSONResponse(
  1084. status_code=status.HTTP_400_BAD_REQUEST,
  1085. content={"detail": str(e)},
  1086. )
  1087. return data
  1088. ##################################
  1089. #
  1090. # Task Endpoints
  1091. #
  1092. ##################################
  1093. # TODO: Refactor task API endpoints below into a separate file
  1094. @app.get("/api/task/config")
  1095. async def get_task_config(user=Depends(get_verified_user)):
  1096. return {
  1097. "TASK_MODEL": app.state.config.TASK_MODEL,
  1098. "TASK_MODEL_EXTERNAL": app.state.config.TASK_MODEL_EXTERNAL,
  1099. "TITLE_GENERATION_PROMPT_TEMPLATE": app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE,
  1100. "ENABLE_SEARCH_QUERY": app.state.config.ENABLE_SEARCH_QUERY,
  1101. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE": app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE,
  1102. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  1103. }
  1104. class TaskConfigForm(BaseModel):
  1105. TASK_MODEL: Optional[str]
  1106. TASK_MODEL_EXTERNAL: Optional[str]
  1107. TITLE_GENERATION_PROMPT_TEMPLATE: str
  1108. SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE: str
  1109. ENABLE_SEARCH_QUERY: bool
  1110. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE: str
  1111. @app.post("/api/task/config/update")
  1112. async def update_task_config(form_data: TaskConfigForm, user=Depends(get_admin_user)):
  1113. app.state.config.TASK_MODEL = form_data.TASK_MODEL
  1114. app.state.config.TASK_MODEL_EXTERNAL = form_data.TASK_MODEL_EXTERNAL
  1115. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = (
  1116. form_data.TITLE_GENERATION_PROMPT_TEMPLATE
  1117. )
  1118. app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE = (
  1119. form_data.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE
  1120. )
  1121. app.state.config.ENABLE_SEARCH_QUERY = form_data.ENABLE_SEARCH_QUERY
  1122. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  1123. form_data.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  1124. )
  1125. return {
  1126. "TASK_MODEL": app.state.config.TASK_MODEL,
  1127. "TASK_MODEL_EXTERNAL": app.state.config.TASK_MODEL_EXTERNAL,
  1128. "TITLE_GENERATION_PROMPT_TEMPLATE": app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE,
  1129. "SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE": app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE,
  1130. "ENABLE_SEARCH_QUERY": app.state.config.ENABLE_SEARCH_QUERY,
  1131. "TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE": app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  1132. }
  1133. @app.post("/api/task/title/completions")
  1134. async def generate_title(form_data: dict, user=Depends(get_verified_user)):
  1135. print("generate_title")
  1136. model_id = form_data["model"]
  1137. if model_id not in app.state.MODELS:
  1138. raise HTTPException(
  1139. status_code=status.HTTP_404_NOT_FOUND,
  1140. detail="Model not found",
  1141. )
  1142. # Check if the user has a custom task model
  1143. # If the user has a custom task model, use that model
  1144. model_id = get_task_model_id(model_id)
  1145. print(model_id)
  1146. if app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE != "":
  1147. template = app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE
  1148. else:
  1149. template = """Create a concise, 3-5 word title with an emoji as a title for the prompt in the given language. Suitable Emojis for the summary can be used to enhance understanding but avoid quotation marks or special formatting. RESPOND ONLY WITH THE TITLE TEXT.
  1150. Examples of titles:
  1151. 📉 Stock Market Trends
  1152. 🍪 Perfect Chocolate Chip Recipe
  1153. Evolution of Music Streaming
  1154. Remote Work Productivity Tips
  1155. Artificial Intelligence in Healthcare
  1156. 🎮 Video Game Development Insights
  1157. Prompt: {{prompt:middletruncate:8000}}"""
  1158. content = title_generation_template(
  1159. template,
  1160. form_data["prompt"],
  1161. {
  1162. "name": user.name,
  1163. "location": user.info.get("location") if user.info else None,
  1164. },
  1165. )
  1166. payload = {
  1167. "model": model_id,
  1168. "messages": [{"role": "user", "content": content}],
  1169. "stream": False,
  1170. "max_tokens": 50,
  1171. "chat_id": form_data.get("chat_id", None),
  1172. "metadata": {"task": str(TASKS.TITLE_GENERATION)},
  1173. }
  1174. log.debug(payload)
  1175. try:
  1176. payload = filter_pipeline(payload, user)
  1177. except Exception as e:
  1178. if len(e.args) > 1:
  1179. return JSONResponse(
  1180. status_code=e.args[0],
  1181. content={"detail": e.args[1]},
  1182. )
  1183. else:
  1184. return JSONResponse(
  1185. status_code=status.HTTP_400_BAD_REQUEST,
  1186. content={"detail": str(e)},
  1187. )
  1188. if "chat_id" in payload:
  1189. del payload["chat_id"]
  1190. return await generate_chat_completions(form_data=payload, user=user)
  1191. @app.post("/api/task/query/completions")
  1192. async def generate_search_query(form_data: dict, user=Depends(get_verified_user)):
  1193. print("generate_search_query")
  1194. if not app.state.config.ENABLE_SEARCH_QUERY:
  1195. raise HTTPException(
  1196. status_code=status.HTTP_400_BAD_REQUEST,
  1197. detail=f"Search query generation is disabled",
  1198. )
  1199. model_id = form_data["model"]
  1200. if model_id not in app.state.MODELS:
  1201. raise HTTPException(
  1202. status_code=status.HTTP_404_NOT_FOUND,
  1203. detail="Model not found",
  1204. )
  1205. # Check if the user has a custom task model
  1206. # If the user has a custom task model, use that model
  1207. model_id = get_task_model_id(model_id)
  1208. print(model_id)
  1209. if app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE != "":
  1210. template = app.state.config.SEARCH_QUERY_GENERATION_PROMPT_TEMPLATE
  1211. else:
  1212. template = """Given the user's message and interaction history, decide if a web search is necessary. You must be concise and exclusively provide a search query if one is necessary. Refrain from verbose responses or any additional commentary. Prefer suggesting a search if uncertain to provide comprehensive or updated information. If a search isn't needed at all, respond with an empty string. Default to a search query when in doubt. Today's date is {{CURRENT_DATE}}.
  1213. User Message:
  1214. {{prompt:end:4000}}
  1215. Interaction History:
  1216. {{MESSAGES:END:6}}
  1217. Search Query:"""
  1218. content = search_query_generation_template(
  1219. template, form_data["messages"], {"name": user.name}
  1220. )
  1221. print("content", content)
  1222. payload = {
  1223. "model": model_id,
  1224. "messages": [{"role": "user", "content": content}],
  1225. "stream": False,
  1226. "max_tokens": 30,
  1227. "metadata": {"task": str(TASKS.QUERY_GENERATION)},
  1228. }
  1229. print(payload)
  1230. try:
  1231. payload = filter_pipeline(payload, user)
  1232. except Exception as e:
  1233. if len(e.args) > 1:
  1234. return JSONResponse(
  1235. status_code=e.args[0],
  1236. content={"detail": e.args[1]},
  1237. )
  1238. else:
  1239. return JSONResponse(
  1240. status_code=status.HTTP_400_BAD_REQUEST,
  1241. content={"detail": str(e)},
  1242. )
  1243. if "chat_id" in payload:
  1244. del payload["chat_id"]
  1245. return await generate_chat_completions(form_data=payload, user=user)
  1246. @app.post("/api/task/emoji/completions")
  1247. async def generate_emoji(form_data: dict, user=Depends(get_verified_user)):
  1248. print("generate_emoji")
  1249. model_id = form_data["model"]
  1250. if model_id not in app.state.MODELS:
  1251. raise HTTPException(
  1252. status_code=status.HTTP_404_NOT_FOUND,
  1253. detail="Model not found",
  1254. )
  1255. # Check if the user has a custom task model
  1256. # If the user has a custom task model, use that model
  1257. model_id = get_task_model_id(model_id)
  1258. print(model_id)
  1259. template = '''
  1260. Your task is to reflect the speaker's likely facial expression through a fitting emoji. Interpret emotions from the message and reflect their facial expression using fitting, diverse emojis (e.g., 😊, 😢, 😡, 😱).
  1261. Message: """{{prompt}}"""
  1262. '''
  1263. content = title_generation_template(
  1264. template,
  1265. form_data["prompt"],
  1266. {
  1267. "name": user.name,
  1268. "location": user.info.get("location") if user.info else None,
  1269. },
  1270. )
  1271. payload = {
  1272. "model": model_id,
  1273. "messages": [{"role": "user", "content": content}],
  1274. "stream": False,
  1275. "max_tokens": 4,
  1276. "chat_id": form_data.get("chat_id", None),
  1277. "metadata": {"task": str(TASKS.EMOJI_GENERATION)},
  1278. }
  1279. log.debug(payload)
  1280. try:
  1281. payload = filter_pipeline(payload, user)
  1282. except Exception as e:
  1283. if len(e.args) > 1:
  1284. return JSONResponse(
  1285. status_code=e.args[0],
  1286. content={"detail": e.args[1]},
  1287. )
  1288. else:
  1289. return JSONResponse(
  1290. status_code=status.HTTP_400_BAD_REQUEST,
  1291. content={"detail": str(e)},
  1292. )
  1293. if "chat_id" in payload:
  1294. del payload["chat_id"]
  1295. return await generate_chat_completions(form_data=payload, user=user)
  1296. @app.post("/api/task/moa/completions")
  1297. async def generate_moa_response(form_data: dict, user=Depends(get_verified_user)):
  1298. print("generate_moa_response")
  1299. model_id = form_data["model"]
  1300. if model_id not in app.state.MODELS:
  1301. raise HTTPException(
  1302. status_code=status.HTTP_404_NOT_FOUND,
  1303. detail="Model not found",
  1304. )
  1305. # Check if the user has a custom task model
  1306. # If the user has a custom task model, use that model
  1307. model_id = get_task_model_id(model_id)
  1308. print(model_id)
  1309. template = """You have been provided with a set of responses from various models to the latest user query: "{{prompt}}"
  1310. Your task is to synthesize these responses into a single, high-quality response. It is crucial to critically evaluate the information provided in these responses, recognizing that some of it may be biased or incorrect. Your response should not simply replicate the given answers but should offer a refined, accurate, and comprehensive reply to the instruction. Ensure your response is well-structured, coherent, and adheres to the highest standards of accuracy and reliability.
  1311. Responses from models: {{responses}}"""
  1312. content = moa_response_generation_template(
  1313. template,
  1314. form_data["prompt"],
  1315. form_data["responses"],
  1316. )
  1317. payload = {
  1318. "model": model_id,
  1319. "messages": [{"role": "user", "content": content}],
  1320. "stream": form_data.get("stream", False),
  1321. "chat_id": form_data.get("chat_id", None),
  1322. "metadata": {"task": str(TASKS.MOA_RESPONSE_GENERATION)},
  1323. }
  1324. log.debug(payload)
  1325. try:
  1326. payload = filter_pipeline(payload, user)
  1327. except Exception as e:
  1328. if len(e.args) > 1:
  1329. return JSONResponse(
  1330. status_code=e.args[0],
  1331. content={"detail": e.args[1]},
  1332. )
  1333. else:
  1334. return JSONResponse(
  1335. status_code=status.HTTP_400_BAD_REQUEST,
  1336. content={"detail": str(e)},
  1337. )
  1338. if "chat_id" in payload:
  1339. del payload["chat_id"]
  1340. return await generate_chat_completions(form_data=payload, user=user)
  1341. ##################################
  1342. #
  1343. # Pipelines Endpoints
  1344. #
  1345. ##################################
  1346. # TODO: Refactor pipelines API endpoints below into a separate file
  1347. @app.get("/api/pipelines/list")
  1348. async def get_pipelines_list(user=Depends(get_admin_user)):
  1349. responses = await get_openai_models(raw=True)
  1350. print(responses)
  1351. urlIdxs = [
  1352. idx
  1353. for idx, response in enumerate(responses)
  1354. if response is not None and "pipelines" in response
  1355. ]
  1356. return {
  1357. "data": [
  1358. {
  1359. "url": openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx],
  1360. "idx": urlIdx,
  1361. }
  1362. for urlIdx in urlIdxs
  1363. ]
  1364. }
  1365. @app.post("/api/pipelines/upload")
  1366. async def upload_pipeline(
  1367. urlIdx: int = Form(...), file: UploadFile = File(...), user=Depends(get_admin_user)
  1368. ):
  1369. print("upload_pipeline", urlIdx, file.filename)
  1370. # Check if the uploaded file is a python file
  1371. if not (file.filename and file.filename.endswith(".py")):
  1372. raise HTTPException(
  1373. status_code=status.HTTP_400_BAD_REQUEST,
  1374. detail="Only Python (.py) files are allowed.",
  1375. )
  1376. upload_folder = f"{CACHE_DIR}/pipelines"
  1377. os.makedirs(upload_folder, exist_ok=True)
  1378. file_path = os.path.join(upload_folder, file.filename)
  1379. r = None
  1380. try:
  1381. # Save the uploaded file
  1382. with open(file_path, "wb") as buffer:
  1383. shutil.copyfileobj(file.file, buffer)
  1384. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  1385. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  1386. headers = {"Authorization": f"Bearer {key}"}
  1387. with open(file_path, "rb") as f:
  1388. files = {"file": f}
  1389. r = requests.post(f"{url}/pipelines/upload", headers=headers, files=files)
  1390. r.raise_for_status()
  1391. data = r.json()
  1392. return {**data}
  1393. except Exception as e:
  1394. # Handle connection error here
  1395. print(f"Connection error: {e}")
  1396. detail = "Pipeline not found"
  1397. status_code = status.HTTP_404_NOT_FOUND
  1398. if r is not None:
  1399. status_code = r.status_code
  1400. try:
  1401. res = r.json()
  1402. if "detail" in res:
  1403. detail = res["detail"]
  1404. except Exception:
  1405. pass
  1406. raise HTTPException(
  1407. status_code=status_code,
  1408. detail=detail,
  1409. )
  1410. finally:
  1411. # Ensure the file is deleted after the upload is completed or on failure
  1412. if os.path.exists(file_path):
  1413. os.remove(file_path)
  1414. class AddPipelineForm(BaseModel):
  1415. url: str
  1416. urlIdx: int
  1417. @app.post("/api/pipelines/add")
  1418. async def add_pipeline(form_data: AddPipelineForm, user=Depends(get_admin_user)):
  1419. r = None
  1420. try:
  1421. urlIdx = form_data.urlIdx
  1422. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  1423. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  1424. headers = {"Authorization": f"Bearer {key}"}
  1425. r = requests.post(
  1426. f"{url}/pipelines/add", headers=headers, json={"url": form_data.url}
  1427. )
  1428. r.raise_for_status()
  1429. data = r.json()
  1430. return {**data}
  1431. except Exception as e:
  1432. # Handle connection error here
  1433. print(f"Connection error: {e}")
  1434. detail = "Pipeline not found"
  1435. if r is not None:
  1436. try:
  1437. res = r.json()
  1438. if "detail" in res:
  1439. detail = res["detail"]
  1440. except Exception:
  1441. pass
  1442. raise HTTPException(
  1443. status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
  1444. detail=detail,
  1445. )
  1446. class DeletePipelineForm(BaseModel):
  1447. id: str
  1448. urlIdx: int
  1449. @app.delete("/api/pipelines/delete")
  1450. async def delete_pipeline(form_data: DeletePipelineForm, user=Depends(get_admin_user)):
  1451. r = None
  1452. try:
  1453. urlIdx = form_data.urlIdx
  1454. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  1455. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  1456. headers = {"Authorization": f"Bearer {key}"}
  1457. r = requests.delete(
  1458. f"{url}/pipelines/delete", headers=headers, json={"id": form_data.id}
  1459. )
  1460. r.raise_for_status()
  1461. data = r.json()
  1462. return {**data}
  1463. except Exception as e:
  1464. # Handle connection error here
  1465. print(f"Connection error: {e}")
  1466. detail = "Pipeline not found"
  1467. if r is not None:
  1468. try:
  1469. res = r.json()
  1470. if "detail" in res:
  1471. detail = res["detail"]
  1472. except Exception:
  1473. pass
  1474. raise HTTPException(
  1475. status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
  1476. detail=detail,
  1477. )
  1478. @app.get("/api/pipelines")
  1479. async def get_pipelines(urlIdx: Optional[int] = None, user=Depends(get_admin_user)):
  1480. r = None
  1481. try:
  1482. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  1483. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  1484. headers = {"Authorization": f"Bearer {key}"}
  1485. r = requests.get(f"{url}/pipelines", headers=headers)
  1486. r.raise_for_status()
  1487. data = r.json()
  1488. return {**data}
  1489. except Exception as e:
  1490. # Handle connection error here
  1491. print(f"Connection error: {e}")
  1492. detail = "Pipeline not found"
  1493. if r is not None:
  1494. try:
  1495. res = r.json()
  1496. if "detail" in res:
  1497. detail = res["detail"]
  1498. except Exception:
  1499. pass
  1500. raise HTTPException(
  1501. status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
  1502. detail=detail,
  1503. )
  1504. @app.get("/api/pipelines/{pipeline_id}/valves")
  1505. async def get_pipeline_valves(
  1506. urlIdx: Optional[int],
  1507. pipeline_id: str,
  1508. user=Depends(get_admin_user),
  1509. ):
  1510. r = None
  1511. try:
  1512. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  1513. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  1514. headers = {"Authorization": f"Bearer {key}"}
  1515. r = requests.get(f"{url}/{pipeline_id}/valves", headers=headers)
  1516. r.raise_for_status()
  1517. data = r.json()
  1518. return {**data}
  1519. except Exception as e:
  1520. # Handle connection error here
  1521. print(f"Connection error: {e}")
  1522. detail = "Pipeline not found"
  1523. if r is not None:
  1524. try:
  1525. res = r.json()
  1526. if "detail" in res:
  1527. detail = res["detail"]
  1528. except Exception:
  1529. pass
  1530. raise HTTPException(
  1531. status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
  1532. detail=detail,
  1533. )
  1534. @app.get("/api/pipelines/{pipeline_id}/valves/spec")
  1535. async def get_pipeline_valves_spec(
  1536. urlIdx: Optional[int],
  1537. pipeline_id: str,
  1538. user=Depends(get_admin_user),
  1539. ):
  1540. r = None
  1541. try:
  1542. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  1543. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  1544. headers = {"Authorization": f"Bearer {key}"}
  1545. r = requests.get(f"{url}/{pipeline_id}/valves/spec", headers=headers)
  1546. r.raise_for_status()
  1547. data = r.json()
  1548. return {**data}
  1549. except Exception as e:
  1550. # Handle connection error here
  1551. print(f"Connection error: {e}")
  1552. detail = "Pipeline not found"
  1553. if r is not None:
  1554. try:
  1555. res = r.json()
  1556. if "detail" in res:
  1557. detail = res["detail"]
  1558. except Exception:
  1559. pass
  1560. raise HTTPException(
  1561. status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
  1562. detail=detail,
  1563. )
  1564. @app.post("/api/pipelines/{pipeline_id}/valves/update")
  1565. async def update_pipeline_valves(
  1566. urlIdx: Optional[int],
  1567. pipeline_id: str,
  1568. form_data: dict,
  1569. user=Depends(get_admin_user),
  1570. ):
  1571. r = None
  1572. try:
  1573. url = openai_app.state.config.OPENAI_API_BASE_URLS[urlIdx]
  1574. key = openai_app.state.config.OPENAI_API_KEYS[urlIdx]
  1575. headers = {"Authorization": f"Bearer {key}"}
  1576. r = requests.post(
  1577. f"{url}/{pipeline_id}/valves/update",
  1578. headers=headers,
  1579. json={**form_data},
  1580. )
  1581. r.raise_for_status()
  1582. data = r.json()
  1583. return {**data}
  1584. except Exception as e:
  1585. # Handle connection error here
  1586. print(f"Connection error: {e}")
  1587. detail = "Pipeline not found"
  1588. if r is not None:
  1589. try:
  1590. res = r.json()
  1591. if "detail" in res:
  1592. detail = res["detail"]
  1593. except Exception:
  1594. pass
  1595. raise HTTPException(
  1596. status_code=(r.status_code if r is not None else status.HTTP_404_NOT_FOUND),
  1597. detail=detail,
  1598. )
  1599. ##################################
  1600. #
  1601. # Config Endpoints
  1602. #
  1603. ##################################
  1604. @app.get("/api/config")
  1605. async def get_app_config(request: Request):
  1606. user = None
  1607. if "token" in request.cookies:
  1608. token = request.cookies.get("token")
  1609. data = decode_token(token)
  1610. if data is not None and "id" in data:
  1611. user = Users.get_user_by_id(data["id"])
  1612. return {
  1613. "status": True,
  1614. "name": WEBUI_NAME,
  1615. "version": VERSION,
  1616. "default_locale": str(DEFAULT_LOCALE),
  1617. "oauth": {
  1618. "providers": {
  1619. name: config.get("name", name)
  1620. for name, config in OAUTH_PROVIDERS.items()
  1621. }
  1622. },
  1623. "features": {
  1624. "auth": WEBUI_AUTH,
  1625. "auth_trusted_header": bool(webui_app.state.AUTH_TRUSTED_EMAIL_HEADER),
  1626. "enable_signup": webui_app.state.config.ENABLE_SIGNUP,
  1627. "enable_login_form": webui_app.state.config.ENABLE_LOGIN_FORM,
  1628. **(
  1629. {
  1630. "enable_web_search": rag_app.state.config.ENABLE_RAG_WEB_SEARCH,
  1631. "enable_image_generation": images_app.state.config.ENABLED,
  1632. "enable_community_sharing": webui_app.state.config.ENABLE_COMMUNITY_SHARING,
  1633. "enable_message_rating": webui_app.state.config.ENABLE_MESSAGE_RATING,
  1634. "enable_admin_export": ENABLE_ADMIN_EXPORT,
  1635. "enable_admin_chat_access": ENABLE_ADMIN_CHAT_ACCESS,
  1636. }
  1637. if user is not None
  1638. else {}
  1639. ),
  1640. },
  1641. **(
  1642. {
  1643. "default_models": webui_app.state.config.DEFAULT_MODELS,
  1644. "default_prompt_suggestions": webui_app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
  1645. "audio": {
  1646. "tts": {
  1647. "engine": audio_app.state.config.TTS_ENGINE,
  1648. "voice": audio_app.state.config.TTS_VOICE,
  1649. "split_on": audio_app.state.config.TTS_SPLIT_ON,
  1650. },
  1651. "stt": {
  1652. "engine": audio_app.state.config.STT_ENGINE,
  1653. },
  1654. },
  1655. "file": {
  1656. "max_size": rag_app.state.config.FILE_MAX_SIZE,
  1657. "max_count": rag_app.state.config.FILE_MAX_COUNT,
  1658. },
  1659. "permissions": {**webui_app.state.config.USER_PERMISSIONS},
  1660. }
  1661. if user is not None
  1662. else {}
  1663. ),
  1664. }
  1665. @app.get("/api/config/model/filter")
  1666. async def get_model_filter_config(user=Depends(get_admin_user)):
  1667. return {
  1668. "enabled": app.state.config.ENABLE_MODEL_FILTER,
  1669. "models": app.state.config.MODEL_FILTER_LIST,
  1670. }
  1671. class ModelFilterConfigForm(BaseModel):
  1672. enabled: bool
  1673. models: list[str]
  1674. @app.post("/api/config/model/filter")
  1675. async def update_model_filter_config(
  1676. form_data: ModelFilterConfigForm, user=Depends(get_admin_user)
  1677. ):
  1678. app.state.config.ENABLE_MODEL_FILTER = form_data.enabled
  1679. app.state.config.MODEL_FILTER_LIST = form_data.models
  1680. return {
  1681. "enabled": app.state.config.ENABLE_MODEL_FILTER,
  1682. "models": app.state.config.MODEL_FILTER_LIST,
  1683. }
  1684. # TODO: webhook endpoint should be under config endpoints
  1685. @app.get("/api/webhook")
  1686. async def get_webhook_url(user=Depends(get_admin_user)):
  1687. return {
  1688. "url": app.state.config.WEBHOOK_URL,
  1689. }
  1690. class UrlForm(BaseModel):
  1691. url: str
  1692. @app.post("/api/webhook")
  1693. async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
  1694. app.state.config.WEBHOOK_URL = form_data.url
  1695. webui_app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
  1696. return {"url": app.state.config.WEBHOOK_URL}
  1697. @app.get("/api/version")
  1698. async def get_app_version():
  1699. return {
  1700. "version": VERSION,
  1701. }
  1702. @app.get("/api/changelog")
  1703. async def get_app_changelog():
  1704. return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
  1705. @app.get("/api/version/updates")
  1706. async def get_app_latest_release_version():
  1707. try:
  1708. async with aiohttp.ClientSession(trust_env=True) as session:
  1709. async with session.get(
  1710. "https://api.github.com/repos/open-webui/open-webui/releases/latest"
  1711. ) as response:
  1712. response.raise_for_status()
  1713. data = await response.json()
  1714. latest_version = data["tag_name"]
  1715. return {"current": VERSION, "latest": latest_version[1:]}
  1716. except aiohttp.ClientError:
  1717. raise HTTPException(
  1718. status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
  1719. detail=ERROR_MESSAGES.RATE_LIMIT_EXCEEDED,
  1720. )
  1721. ############################
  1722. # OAuth Login & Callback
  1723. ############################
  1724. oauth = OAuth()
  1725. for provider_name, provider_config in OAUTH_PROVIDERS.items():
  1726. oauth.register(
  1727. name=provider_name,
  1728. client_id=provider_config["client_id"],
  1729. client_secret=provider_config["client_secret"],
  1730. server_metadata_url=provider_config["server_metadata_url"],
  1731. client_kwargs={
  1732. "scope": provider_config["scope"],
  1733. },
  1734. redirect_uri=provider_config["redirect_uri"],
  1735. )
  1736. # SessionMiddleware is used by authlib for oauth
  1737. if len(OAUTH_PROVIDERS) > 0:
  1738. app.add_middleware(
  1739. SessionMiddleware,
  1740. secret_key=WEBUI_SECRET_KEY,
  1741. session_cookie="oui-session",
  1742. same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  1743. https_only=WEBUI_SESSION_COOKIE_SECURE,
  1744. )
  1745. @app.get("/oauth/{provider}/login")
  1746. async def oauth_login(provider: str, request: Request):
  1747. if provider not in OAUTH_PROVIDERS:
  1748. raise HTTPException(404)
  1749. # If the provider has a custom redirect URL, use that, otherwise automatically generate one
  1750. redirect_uri = OAUTH_PROVIDERS[provider].get("redirect_uri") or request.url_for(
  1751. "oauth_callback", provider=provider
  1752. )
  1753. client = oauth.create_client(provider)
  1754. if client is None:
  1755. raise HTTPException(404)
  1756. return await client.authorize_redirect(request, redirect_uri)
  1757. # OAuth login logic is as follows:
  1758. # 1. Attempt to find a user with matching subject ID, tied to the provider
  1759. # 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
  1760. # - This is considered insecure in general, as OAuth providers do not always verify email addresses
  1761. # 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
  1762. # - Email addresses are considered unique, so we fail registration if the email address is alreayd taken
  1763. @app.get("/oauth/{provider}/callback")
  1764. async def oauth_callback(provider: str, request: Request, response: Response):
  1765. if provider not in OAUTH_PROVIDERS:
  1766. raise HTTPException(404)
  1767. client = oauth.create_client(provider)
  1768. try:
  1769. token = await client.authorize_access_token(request)
  1770. except Exception as e:
  1771. log.warning(f"OAuth callback error: {e}")
  1772. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  1773. user_data: UserInfo = token["userinfo"]
  1774. sub = user_data.get("sub")
  1775. if not sub:
  1776. log.warning(f"OAuth callback failed, sub is missing: {user_data}")
  1777. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  1778. provider_sub = f"{provider}@{sub}"
  1779. email_claim = webui_app.state.config.OAUTH_EMAIL_CLAIM
  1780. email = user_data.get(email_claim, "").lower()
  1781. # We currently mandate that email addresses are provided
  1782. if not email:
  1783. log.warning(f"OAuth callback failed, email is missing: {user_data}")
  1784. raise HTTPException(400, detail=ERROR_MESSAGES.INVALID_CRED)
  1785. # Check if the user exists
  1786. user = Users.get_user_by_oauth_sub(provider_sub)
  1787. if not user:
  1788. # If the user does not exist, check if merging is enabled
  1789. if OAUTH_MERGE_ACCOUNTS_BY_EMAIL.value:
  1790. # Check if the user exists by email
  1791. user = Users.get_user_by_email(email)
  1792. if user:
  1793. # Update the user with the new oauth sub
  1794. Users.update_user_oauth_sub_by_id(user.id, provider_sub)
  1795. if not user:
  1796. # If the user does not exist, check if signups are enabled
  1797. if ENABLE_OAUTH_SIGNUP.value:
  1798. # Check if an existing user with the same email already exists
  1799. existing_user = Users.get_user_by_email(user_data.get("email", "").lower())
  1800. if existing_user:
  1801. raise HTTPException(400, detail=ERROR_MESSAGES.EMAIL_TAKEN)
  1802. picture_claim = webui_app.state.config.OAUTH_PICTURE_CLAIM
  1803. picture_url = user_data.get(picture_claim, "")
  1804. if picture_url:
  1805. # Download the profile image into a base64 string
  1806. try:
  1807. async with aiohttp.ClientSession() as session:
  1808. async with session.get(picture_url) as resp:
  1809. picture = await resp.read()
  1810. base64_encoded_picture = base64.b64encode(picture).decode(
  1811. "utf-8"
  1812. )
  1813. guessed_mime_type = mimetypes.guess_type(picture_url)[0]
  1814. if guessed_mime_type is None:
  1815. # assume JPG, browsers are tolerant enough of image formats
  1816. guessed_mime_type = "image/jpeg"
  1817. picture_url = f"data:{guessed_mime_type};base64,{base64_encoded_picture}"
  1818. except Exception as e:
  1819. log.error(f"Error downloading profile image '{picture_url}': {e}")
  1820. picture_url = ""
  1821. if not picture_url:
  1822. picture_url = "/user.png"
  1823. username_claim = webui_app.state.config.OAUTH_USERNAME_CLAIM
  1824. role = (
  1825. "admin"
  1826. if Users.get_num_users() == 0
  1827. else webui_app.state.config.DEFAULT_USER_ROLE
  1828. )
  1829. user = Auths.insert_new_auth(
  1830. email=email,
  1831. password=get_password_hash(
  1832. str(uuid.uuid4())
  1833. ), # Random password, not used
  1834. name=user_data.get(username_claim, "User"),
  1835. profile_image_url=picture_url,
  1836. role=role,
  1837. oauth_sub=provider_sub,
  1838. )
  1839. if webui_app.state.config.WEBHOOK_URL:
  1840. post_webhook(
  1841. webui_app.state.config.WEBHOOK_URL,
  1842. WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  1843. {
  1844. "action": "signup",
  1845. "message": WEBHOOK_MESSAGES.USER_SIGNUP(user.name),
  1846. "user": user.model_dump_json(exclude_none=True),
  1847. },
  1848. )
  1849. else:
  1850. raise HTTPException(
  1851. status.HTTP_403_FORBIDDEN, detail=ERROR_MESSAGES.ACCESS_PROHIBITED
  1852. )
  1853. jwt_token = create_token(
  1854. data={"id": user.id},
  1855. expires_delta=parse_duration(webui_app.state.config.JWT_EXPIRES_IN),
  1856. )
  1857. # Set the cookie token
  1858. response.set_cookie(
  1859. key="token",
  1860. value=jwt_token,
  1861. httponly=True, # Ensures the cookie is not accessible via JavaScript
  1862. )
  1863. # Redirect back to the frontend with the JWT token
  1864. redirect_url = f"{request.base_url}auth#token={jwt_token}"
  1865. return RedirectResponse(url=redirect_url)
  1866. @app.get("/manifest.json")
  1867. async def get_manifest_json():
  1868. return {
  1869. "name": WEBUI_NAME,
  1870. "short_name": WEBUI_NAME,
  1871. "start_url": "/",
  1872. "display": "standalone",
  1873. "background_color": "#343541",
  1874. "orientation": "portrait-primary",
  1875. "icons": [
  1876. {
  1877. "src": "/static/logo.png",
  1878. "type": "image/png",
  1879. "sizes": "500x500",
  1880. "purpose": "any",
  1881. },
  1882. {
  1883. "src": "/static/logo.png",
  1884. "type": "image/png",
  1885. "sizes": "500x500",
  1886. "purpose": "maskable",
  1887. },
  1888. ],
  1889. }
  1890. @app.get("/opensearch.xml")
  1891. async def get_opensearch_xml():
  1892. xml_content = rf"""
  1893. <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  1894. <ShortName>{WEBUI_NAME}</ShortName>
  1895. <Description>Search {WEBUI_NAME}</Description>
  1896. <InputEncoding>UTF-8</InputEncoding>
  1897. <Image width="16" height="16" type="image/x-icon">{WEBUI_URL}/static/favicon.png</Image>
  1898. <Url type="text/html" method="get" template="{WEBUI_URL}/?q={"{searchTerms}"}"/>
  1899. <moz:SearchForm>{WEBUI_URL}</moz:SearchForm>
  1900. </OpenSearchDescription>
  1901. """
  1902. return Response(content=xml_content, media_type="application/xml")
  1903. @app.get("/health")
  1904. async def healthcheck():
  1905. return {"status": True}
  1906. @app.get("/health/db")
  1907. async def healthcheck_with_db():
  1908. Session.execute(text("SELECT 1;")).all()
  1909. return {"status": True}
  1910. app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
  1911. app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
  1912. if os.path.exists(FRONTEND_BUILD_DIR):
  1913. mimetypes.add_type("text/javascript", ".js")
  1914. app.mount(
  1915. "/",
  1916. SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
  1917. name="spa-static-files",
  1918. )
  1919. else:
  1920. log.warning(
  1921. f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
  1922. )