main.py 50 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553
  1. import asyncio
  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 random
  11. from contextlib import asynccontextmanager
  12. from urllib.parse import urlencode, parse_qs, urlparse
  13. from pydantic import BaseModel
  14. from sqlalchemy import text
  15. from typing import Optional
  16. from aiocache import cached
  17. import aiohttp
  18. import anyio.to_thread
  19. import requests
  20. from fastapi import (
  21. Depends,
  22. FastAPI,
  23. File,
  24. Form,
  25. HTTPException,
  26. Request,
  27. UploadFile,
  28. status,
  29. applications,
  30. BackgroundTasks,
  31. )
  32. from fastapi.openapi.docs import get_swagger_ui_html
  33. from fastapi.middleware.cors import CORSMiddleware
  34. from fastapi.responses import JSONResponse, RedirectResponse
  35. from fastapi.staticfiles import StaticFiles
  36. from starlette.exceptions import HTTPException as StarletteHTTPException
  37. from starlette.middleware.base import BaseHTTPMiddleware
  38. from starlette.middleware.sessions import SessionMiddleware
  39. from starlette.responses import Response, StreamingResponse
  40. from open_webui.utils import logger
  41. from open_webui.utils.audit import AuditLevel, AuditLoggingMiddleware
  42. from open_webui.utils.logger import start_logger
  43. from open_webui.socket.main import (
  44. app as socket_app,
  45. periodic_usage_pool_cleanup,
  46. )
  47. from open_webui.routers import (
  48. audio,
  49. images,
  50. ollama,
  51. openai,
  52. retrieval,
  53. pipelines,
  54. tasks,
  55. auths,
  56. channels,
  57. chats,
  58. folders,
  59. configs,
  60. groups,
  61. files,
  62. functions,
  63. memories,
  64. models,
  65. knowledge,
  66. prompts,
  67. evaluations,
  68. tools,
  69. users,
  70. utils,
  71. )
  72. from open_webui.routers.retrieval import (
  73. get_embedding_function,
  74. get_ef,
  75. get_rf,
  76. )
  77. from open_webui.internal.db import Session, engine
  78. from open_webui.models.functions import Functions
  79. from open_webui.models.models import Models
  80. from open_webui.models.users import UserModel, Users
  81. from open_webui.models.chats import Chats
  82. from open_webui.config import (
  83. LICENSE_KEY,
  84. # Ollama
  85. ENABLE_OLLAMA_API,
  86. OLLAMA_BASE_URLS,
  87. OLLAMA_API_CONFIGS,
  88. # OpenAI
  89. ENABLE_OPENAI_API,
  90. ONEDRIVE_CLIENT_ID,
  91. ONEDRIVE_SHAREPOINT_URL,
  92. OPENAI_API_BASE_URLS,
  93. OPENAI_API_KEYS,
  94. OPENAI_API_CONFIGS,
  95. # Direct Connections
  96. ENABLE_DIRECT_CONNECTIONS,
  97. # Thread pool size for FastAPI/AnyIO
  98. THREAD_POOL_SIZE,
  99. # Tool Server Configs
  100. TOOL_SERVER_CONNECTIONS,
  101. # Code Execution
  102. ENABLE_CODE_EXECUTION,
  103. CODE_EXECUTION_ENGINE,
  104. CODE_EXECUTION_JUPYTER_URL,
  105. CODE_EXECUTION_JUPYTER_AUTH,
  106. CODE_EXECUTION_JUPYTER_AUTH_TOKEN,
  107. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD,
  108. CODE_EXECUTION_JUPYTER_TIMEOUT,
  109. ENABLE_CODE_INTERPRETER,
  110. CODE_INTERPRETER_ENGINE,
  111. CODE_INTERPRETER_PROMPT_TEMPLATE,
  112. CODE_INTERPRETER_JUPYTER_URL,
  113. CODE_INTERPRETER_JUPYTER_AUTH,
  114. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN,
  115. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD,
  116. CODE_INTERPRETER_JUPYTER_TIMEOUT,
  117. # Image
  118. AUTOMATIC1111_API_AUTH,
  119. AUTOMATIC1111_BASE_URL,
  120. AUTOMATIC1111_CFG_SCALE,
  121. AUTOMATIC1111_SAMPLER,
  122. AUTOMATIC1111_SCHEDULER,
  123. COMFYUI_BASE_URL,
  124. COMFYUI_API_KEY,
  125. COMFYUI_WORKFLOW,
  126. COMFYUI_WORKFLOW_NODES,
  127. ENABLE_IMAGE_GENERATION,
  128. ENABLE_IMAGE_PROMPT_GENERATION,
  129. IMAGE_GENERATION_ENGINE,
  130. IMAGE_GENERATION_MODEL,
  131. IMAGE_SIZE,
  132. IMAGE_STEPS,
  133. IMAGES_OPENAI_API_BASE_URL,
  134. IMAGES_OPENAI_API_KEY,
  135. IMAGES_GEMINI_API_BASE_URL,
  136. IMAGES_GEMINI_API_KEY,
  137. # Audio
  138. AUDIO_STT_ENGINE,
  139. AUDIO_STT_MODEL,
  140. AUDIO_STT_OPENAI_API_BASE_URL,
  141. AUDIO_STT_OPENAI_API_KEY,
  142. AUDIO_STT_AZURE_API_KEY,
  143. AUDIO_STT_AZURE_REGION,
  144. AUDIO_STT_AZURE_LOCALES,
  145. AUDIO_STT_AZURE_BASE_URL,
  146. AUDIO_STT_AZURE_MAX_SPEAKERS,
  147. AUDIO_TTS_API_KEY,
  148. AUDIO_TTS_ENGINE,
  149. AUDIO_TTS_MODEL,
  150. AUDIO_TTS_OPENAI_API_BASE_URL,
  151. AUDIO_TTS_OPENAI_API_KEY,
  152. AUDIO_TTS_SPLIT_ON,
  153. AUDIO_TTS_VOICE,
  154. AUDIO_TTS_AZURE_SPEECH_REGION,
  155. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT,
  156. PLAYWRIGHT_WS_URL,
  157. PLAYWRIGHT_TIMEOUT,
  158. FIRECRAWL_API_BASE_URL,
  159. FIRECRAWL_API_KEY,
  160. WEB_LOADER_ENGINE,
  161. WHISPER_MODEL,
  162. WHISPER_VAD_FILTER,
  163. DEEPGRAM_API_KEY,
  164. WHISPER_MODEL_AUTO_UPDATE,
  165. WHISPER_MODEL_DIR,
  166. # Retrieval
  167. RAG_TEMPLATE,
  168. DEFAULT_RAG_TEMPLATE,
  169. RAG_FULL_CONTEXT,
  170. BYPASS_EMBEDDING_AND_RETRIEVAL,
  171. RAG_EMBEDDING_MODEL,
  172. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  173. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  174. RAG_RERANKING_MODEL,
  175. RAG_RERANKING_MODEL_AUTO_UPDATE,
  176. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  177. RAG_EMBEDDING_ENGINE,
  178. RAG_EMBEDDING_BATCH_SIZE,
  179. RAG_RELEVANCE_THRESHOLD,
  180. RAG_FILE_MAX_COUNT,
  181. RAG_FILE_MAX_SIZE,
  182. RAG_OPENAI_API_BASE_URL,
  183. RAG_OPENAI_API_KEY,
  184. RAG_OLLAMA_BASE_URL,
  185. RAG_OLLAMA_API_KEY,
  186. CHUNK_OVERLAP,
  187. CHUNK_SIZE,
  188. CONTENT_EXTRACTION_ENGINE,
  189. TIKA_SERVER_URL,
  190. DOCLING_SERVER_URL,
  191. DOCUMENT_INTELLIGENCE_ENDPOINT,
  192. DOCUMENT_INTELLIGENCE_KEY,
  193. MISTRAL_OCR_API_KEY,
  194. RAG_TOP_K,
  195. RAG_TOP_K_RERANKER,
  196. RAG_TEXT_SPLITTER,
  197. TIKTOKEN_ENCODING_NAME,
  198. PDF_EXTRACT_IMAGES,
  199. YOUTUBE_LOADER_LANGUAGE,
  200. YOUTUBE_LOADER_PROXY_URL,
  201. # Retrieval (Web Search)
  202. ENABLE_WEB_SEARCH,
  203. WEB_SEARCH_ENGINE,
  204. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL,
  205. WEB_SEARCH_RESULT_COUNT,
  206. WEB_SEARCH_CONCURRENT_REQUESTS,
  207. WEB_SEARCH_TRUST_ENV,
  208. WEB_SEARCH_DOMAIN_FILTER_LIST,
  209. JINA_API_KEY,
  210. SEARCHAPI_API_KEY,
  211. SEARCHAPI_ENGINE,
  212. SERPAPI_API_KEY,
  213. SERPAPI_ENGINE,
  214. SEARXNG_QUERY_URL,
  215. YACY_QUERY_URL,
  216. YACY_USERNAME,
  217. YACY_PASSWORD,
  218. SERPER_API_KEY,
  219. SERPLY_API_KEY,
  220. SERPSTACK_API_KEY,
  221. SERPSTACK_HTTPS,
  222. TAVILY_API_KEY,
  223. TAVILY_EXTRACT_DEPTH,
  224. BING_SEARCH_V7_ENDPOINT,
  225. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  226. BRAVE_SEARCH_API_KEY,
  227. EXA_API_KEY,
  228. PERPLEXITY_API_KEY,
  229. SOUGOU_API_SID,
  230. SOUGOU_API_SK,
  231. KAGI_SEARCH_API_KEY,
  232. MOJEEK_SEARCH_API_KEY,
  233. BOCHA_SEARCH_API_KEY,
  234. GOOGLE_PSE_API_KEY,
  235. GOOGLE_PSE_ENGINE_ID,
  236. GOOGLE_DRIVE_CLIENT_ID,
  237. GOOGLE_DRIVE_API_KEY,
  238. ONEDRIVE_CLIENT_ID,
  239. ONEDRIVE_SHAREPOINT_URL,
  240. ENABLE_RAG_HYBRID_SEARCH,
  241. ENABLE_RAG_LOCAL_WEB_FETCH,
  242. ENABLE_WEB_LOADER_SSL_VERIFICATION,
  243. ENABLE_GOOGLE_DRIVE_INTEGRATION,
  244. ENABLE_ONEDRIVE_INTEGRATION,
  245. UPLOAD_DIR,
  246. EXTERNAL_WEB_SEARCH_URL,
  247. EXTERNAL_WEB_SEARCH_API_KEY,
  248. EXTERNAL_WEB_LOADER_URL,
  249. EXTERNAL_WEB_LOADER_API_KEY,
  250. # WebUI
  251. WEBUI_AUTH,
  252. WEBUI_NAME,
  253. WEBUI_BANNERS,
  254. WEBHOOK_URL,
  255. ADMIN_EMAIL,
  256. SHOW_ADMIN_DETAILS,
  257. JWT_EXPIRES_IN,
  258. ENABLE_SIGNUP,
  259. ENABLE_LOGIN_FORM,
  260. ENABLE_API_KEY,
  261. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  262. API_KEY_ALLOWED_ENDPOINTS,
  263. ENABLE_CHANNELS,
  264. ENABLE_COMMUNITY_SHARING,
  265. ENABLE_MESSAGE_RATING,
  266. ENABLE_USER_WEBHOOKS,
  267. ENABLE_EVALUATION_ARENA_MODELS,
  268. USER_PERMISSIONS,
  269. DEFAULT_USER_ROLE,
  270. DEFAULT_PROMPT_SUGGESTIONS,
  271. DEFAULT_MODELS,
  272. DEFAULT_ARENA_MODEL,
  273. MODEL_ORDER_LIST,
  274. EVALUATION_ARENA_MODELS,
  275. # WebUI (OAuth)
  276. ENABLE_OAUTH_ROLE_MANAGEMENT,
  277. OAUTH_ROLES_CLAIM,
  278. OAUTH_EMAIL_CLAIM,
  279. OAUTH_PICTURE_CLAIM,
  280. OAUTH_USERNAME_CLAIM,
  281. OAUTH_ALLOWED_ROLES,
  282. OAUTH_ADMIN_ROLES,
  283. # WebUI (LDAP)
  284. ENABLE_LDAP,
  285. LDAP_SERVER_LABEL,
  286. LDAP_SERVER_HOST,
  287. LDAP_SERVER_PORT,
  288. LDAP_ATTRIBUTE_FOR_MAIL,
  289. LDAP_ATTRIBUTE_FOR_USERNAME,
  290. LDAP_SEARCH_FILTERS,
  291. LDAP_SEARCH_BASE,
  292. LDAP_APP_DN,
  293. LDAP_APP_PASSWORD,
  294. LDAP_USE_TLS,
  295. LDAP_CA_CERT_FILE,
  296. LDAP_CIPHERS,
  297. # Misc
  298. ENV,
  299. CACHE_DIR,
  300. STATIC_DIR,
  301. FRONTEND_BUILD_DIR,
  302. CORS_ALLOW_ORIGIN,
  303. DEFAULT_LOCALE,
  304. OAUTH_PROVIDERS,
  305. WEBUI_URL,
  306. # Admin
  307. ENABLE_ADMIN_CHAT_ACCESS,
  308. ENABLE_ADMIN_EXPORT,
  309. # Tasks
  310. TASK_MODEL,
  311. TASK_MODEL_EXTERNAL,
  312. ENABLE_TAGS_GENERATION,
  313. ENABLE_TITLE_GENERATION,
  314. ENABLE_SEARCH_QUERY_GENERATION,
  315. ENABLE_RETRIEVAL_QUERY_GENERATION,
  316. ENABLE_AUTOCOMPLETE_GENERATION,
  317. TITLE_GENERATION_PROMPT_TEMPLATE,
  318. TAGS_GENERATION_PROMPT_TEMPLATE,
  319. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE,
  320. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  321. QUERY_GENERATION_PROMPT_TEMPLATE,
  322. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE,
  323. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH,
  324. AppConfig,
  325. reset_config,
  326. )
  327. from open_webui.env import (
  328. AUDIT_EXCLUDED_PATHS,
  329. AUDIT_LOG_LEVEL,
  330. CHANGELOG,
  331. REDIS_URL,
  332. REDIS_SENTINEL_HOSTS,
  333. REDIS_SENTINEL_PORT,
  334. GLOBAL_LOG_LEVEL,
  335. MAX_BODY_LOG_SIZE,
  336. SAFE_MODE,
  337. SRC_LOG_LEVELS,
  338. VERSION,
  339. WEBUI_BUILD_HASH,
  340. WEBUI_SECRET_KEY,
  341. WEBUI_SESSION_COOKIE_SAME_SITE,
  342. WEBUI_SESSION_COOKIE_SECURE,
  343. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  344. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  345. WEBUI_AUTH_SIGNOUT_REDIRECT_URL,
  346. ENABLE_WEBSOCKET_SUPPORT,
  347. BYPASS_MODEL_ACCESS_CONTROL,
  348. RESET_CONFIG_ON_START,
  349. OFFLINE_MODE,
  350. ENABLE_OTEL,
  351. EXTERNAL_PWA_MANIFEST_URL,
  352. )
  353. from open_webui.utils.models import (
  354. get_all_models,
  355. get_all_base_models,
  356. check_model_access,
  357. )
  358. from open_webui.utils.chat import (
  359. generate_chat_completion as chat_completion_handler,
  360. chat_completed as chat_completed_handler,
  361. chat_action as chat_action_handler,
  362. )
  363. from open_webui.utils.middleware import process_chat_payload, process_chat_response
  364. from open_webui.utils.access_control import has_access
  365. from open_webui.utils.auth import (
  366. get_license_data,
  367. get_http_authorization_cred,
  368. decode_token,
  369. get_admin_user,
  370. get_verified_user,
  371. )
  372. from open_webui.utils.plugin import install_tool_and_function_dependencies
  373. from open_webui.utils.oauth import OAuthManager
  374. from open_webui.utils.security_headers import SecurityHeadersMiddleware
  375. from open_webui.tasks import (
  376. list_task_ids_by_chat_id,
  377. stop_task,
  378. list_tasks,
  379. ) # Import from tasks.py
  380. from open_webui.utils.redis import get_sentinels_from_env
  381. if SAFE_MODE:
  382. print("SAFE MODE ENABLED")
  383. Functions.deactivate_all_functions()
  384. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  385. log = logging.getLogger(__name__)
  386. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  387. class SPAStaticFiles(StaticFiles):
  388. async def get_response(self, path: str, scope):
  389. try:
  390. return await super().get_response(path, scope)
  391. except (HTTPException, StarletteHTTPException) as ex:
  392. if ex.status_code == 404:
  393. if path.endswith(".js"):
  394. # Return 404 for javascript files
  395. raise ex
  396. else:
  397. return await super().get_response("index.html", scope)
  398. else:
  399. raise ex
  400. print(
  401. rf"""
  402. ██████╗ ██████╗ ███████╗███╗ ██╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██╗
  403. ██╔═══██╗██╔══██╗██╔════╝████╗ ██║ ██║ ██║██╔════╝██╔══██╗██║ ██║██║
  404. ██║ ██║██████╔╝█████╗ ██╔██╗ ██║ ██║ █╗ ██║█████╗ ██████╔╝██║ ██║██║
  405. ██║ ██║██╔═══╝ ██╔══╝ ██║╚██╗██║ ██║███╗██║██╔══╝ ██╔══██╗██║ ██║██║
  406. ╚██████╔╝██║ ███████╗██║ ╚████║ ╚███╔███╔╝███████╗██████╔╝╚██████╔╝██║
  407. ╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝ ╚══╝╚══╝ ╚══════╝╚═════╝ ╚═════╝ ╚═╝
  408. v{VERSION} - building the best open-source AI user interface.
  409. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  410. https://github.com/open-webui/open-webui
  411. """
  412. )
  413. @asynccontextmanager
  414. async def lifespan(app: FastAPI):
  415. start_logger()
  416. if RESET_CONFIG_ON_START:
  417. reset_config()
  418. if LICENSE_KEY:
  419. get_license_data(app, LICENSE_KEY)
  420. # This should be blocking (sync) so functions are not deactivated on first /get_models calls
  421. # when the first user lands on the / route.
  422. log.info("Installing external dependencies of functions and tools...")
  423. install_tool_and_function_dependencies()
  424. pool_size = THREAD_POOL_SIZE
  425. if pool_size and pool_size > 0:
  426. limiter = anyio.to_thread.current_default_thread_limiter()
  427. limiter.total_tokens = pool_size
  428. asyncio.create_task(periodic_usage_pool_cleanup())
  429. yield
  430. app = FastAPI(
  431. title="Open WebUI",
  432. docs_url="/docs" if ENV == "dev" else None,
  433. openapi_url="/openapi.json" if ENV == "dev" else None,
  434. redoc_url=None,
  435. lifespan=lifespan,
  436. )
  437. oauth_manager = OAuthManager(app)
  438. app.state.config = AppConfig(
  439. redis_url=REDIS_URL,
  440. redis_sentinels=get_sentinels_from_env(REDIS_SENTINEL_HOSTS, REDIS_SENTINEL_PORT),
  441. )
  442. app.state.WEBUI_NAME = WEBUI_NAME
  443. app.state.LICENSE_METADATA = None
  444. ########################################
  445. #
  446. # OPENTELEMETRY
  447. #
  448. ########################################
  449. if ENABLE_OTEL:
  450. from open_webui.utils.telemetry.setup import setup as setup_opentelemetry
  451. setup_opentelemetry(app=app, db_engine=engine)
  452. ########################################
  453. #
  454. # OLLAMA
  455. #
  456. ########################################
  457. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  458. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  459. app.state.config.OLLAMA_API_CONFIGS = OLLAMA_API_CONFIGS
  460. app.state.OLLAMA_MODELS = {}
  461. ########################################
  462. #
  463. # OPENAI
  464. #
  465. ########################################
  466. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  467. app.state.config.OPENAI_API_BASE_URLS = OPENAI_API_BASE_URLS
  468. app.state.config.OPENAI_API_KEYS = OPENAI_API_KEYS
  469. app.state.config.OPENAI_API_CONFIGS = OPENAI_API_CONFIGS
  470. app.state.OPENAI_MODELS = {}
  471. ########################################
  472. #
  473. # TOOL SERVERS
  474. #
  475. ########################################
  476. app.state.config.TOOL_SERVER_CONNECTIONS = TOOL_SERVER_CONNECTIONS
  477. app.state.TOOL_SERVERS = []
  478. ########################################
  479. #
  480. # DIRECT CONNECTIONS
  481. #
  482. ########################################
  483. app.state.config.ENABLE_DIRECT_CONNECTIONS = ENABLE_DIRECT_CONNECTIONS
  484. ########################################
  485. #
  486. # WEBUI
  487. #
  488. ########################################
  489. app.state.config.WEBUI_URL = WEBUI_URL
  490. app.state.config.ENABLE_SIGNUP = ENABLE_SIGNUP
  491. app.state.config.ENABLE_LOGIN_FORM = ENABLE_LOGIN_FORM
  492. app.state.config.ENABLE_API_KEY = ENABLE_API_KEY
  493. app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  494. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  495. )
  496. app.state.config.API_KEY_ALLOWED_ENDPOINTS = API_KEY_ALLOWED_ENDPOINTS
  497. app.state.config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  498. app.state.config.SHOW_ADMIN_DETAILS = SHOW_ADMIN_DETAILS
  499. app.state.config.ADMIN_EMAIL = ADMIN_EMAIL
  500. app.state.config.DEFAULT_MODELS = DEFAULT_MODELS
  501. app.state.config.DEFAULT_PROMPT_SUGGESTIONS = DEFAULT_PROMPT_SUGGESTIONS
  502. app.state.config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  503. app.state.config.USER_PERMISSIONS = USER_PERMISSIONS
  504. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  505. app.state.config.BANNERS = WEBUI_BANNERS
  506. app.state.config.MODEL_ORDER_LIST = MODEL_ORDER_LIST
  507. app.state.config.ENABLE_CHANNELS = ENABLE_CHANNELS
  508. app.state.config.ENABLE_COMMUNITY_SHARING = ENABLE_COMMUNITY_SHARING
  509. app.state.config.ENABLE_MESSAGE_RATING = ENABLE_MESSAGE_RATING
  510. app.state.config.ENABLE_USER_WEBHOOKS = ENABLE_USER_WEBHOOKS
  511. app.state.config.ENABLE_EVALUATION_ARENA_MODELS = ENABLE_EVALUATION_ARENA_MODELS
  512. app.state.config.EVALUATION_ARENA_MODELS = EVALUATION_ARENA_MODELS
  513. app.state.config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  514. app.state.config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  515. app.state.config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  516. app.state.config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  517. app.state.config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  518. app.state.config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  519. app.state.config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  520. app.state.config.ENABLE_LDAP = ENABLE_LDAP
  521. app.state.config.LDAP_SERVER_LABEL = LDAP_SERVER_LABEL
  522. app.state.config.LDAP_SERVER_HOST = LDAP_SERVER_HOST
  523. app.state.config.LDAP_SERVER_PORT = LDAP_SERVER_PORT
  524. app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = LDAP_ATTRIBUTE_FOR_MAIL
  525. app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = LDAP_ATTRIBUTE_FOR_USERNAME
  526. app.state.config.LDAP_APP_DN = LDAP_APP_DN
  527. app.state.config.LDAP_APP_PASSWORD = LDAP_APP_PASSWORD
  528. app.state.config.LDAP_SEARCH_BASE = LDAP_SEARCH_BASE
  529. app.state.config.LDAP_SEARCH_FILTERS = LDAP_SEARCH_FILTERS
  530. app.state.config.LDAP_USE_TLS = LDAP_USE_TLS
  531. app.state.config.LDAP_CA_CERT_FILE = LDAP_CA_CERT_FILE
  532. app.state.config.LDAP_CIPHERS = LDAP_CIPHERS
  533. app.state.AUTH_TRUSTED_EMAIL_HEADER = WEBUI_AUTH_TRUSTED_EMAIL_HEADER
  534. app.state.AUTH_TRUSTED_NAME_HEADER = WEBUI_AUTH_TRUSTED_NAME_HEADER
  535. app.state.WEBUI_AUTH_SIGNOUT_REDIRECT_URL = WEBUI_AUTH_SIGNOUT_REDIRECT_URL
  536. app.state.EXTERNAL_PWA_MANIFEST_URL = EXTERNAL_PWA_MANIFEST_URL
  537. app.state.USER_COUNT = None
  538. app.state.TOOLS = {}
  539. app.state.FUNCTIONS = {}
  540. ########################################
  541. #
  542. # RETRIEVAL
  543. #
  544. ########################################
  545. app.state.config.TOP_K = RAG_TOP_K
  546. app.state.config.TOP_K_RERANKER = RAG_TOP_K_RERANKER
  547. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  548. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  549. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  550. app.state.config.RAG_FULL_CONTEXT = RAG_FULL_CONTEXT
  551. app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL = BYPASS_EMBEDDING_AND_RETRIEVAL
  552. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  553. app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION = ENABLE_WEB_LOADER_SSL_VERIFICATION
  554. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  555. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  556. app.state.config.DOCLING_SERVER_URL = DOCLING_SERVER_URL
  557. app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT = DOCUMENT_INTELLIGENCE_ENDPOINT
  558. app.state.config.DOCUMENT_INTELLIGENCE_KEY = DOCUMENT_INTELLIGENCE_KEY
  559. app.state.config.MISTRAL_OCR_API_KEY = MISTRAL_OCR_API_KEY
  560. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  561. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  562. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  563. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  564. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  565. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  566. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  567. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  568. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  569. app.state.config.RAG_OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  570. app.state.config.RAG_OPENAI_API_KEY = RAG_OPENAI_API_KEY
  571. app.state.config.RAG_OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  572. app.state.config.RAG_OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  573. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  574. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  575. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  576. app.state.config.ENABLE_WEB_SEARCH = ENABLE_WEB_SEARCH
  577. app.state.config.WEB_SEARCH_ENGINE = WEB_SEARCH_ENGINE
  578. app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST = WEB_SEARCH_DOMAIN_FILTER_LIST
  579. app.state.config.WEB_SEARCH_RESULT_COUNT = WEB_SEARCH_RESULT_COUNT
  580. app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS = WEB_SEARCH_CONCURRENT_REQUESTS
  581. app.state.config.WEB_LOADER_ENGINE = WEB_LOADER_ENGINE
  582. app.state.config.WEB_SEARCH_TRUST_ENV = WEB_SEARCH_TRUST_ENV
  583. app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL = (
  584. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL
  585. )
  586. app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION = ENABLE_GOOGLE_DRIVE_INTEGRATION
  587. app.state.config.ENABLE_ONEDRIVE_INTEGRATION = ENABLE_ONEDRIVE_INTEGRATION
  588. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  589. app.state.config.YACY_QUERY_URL = YACY_QUERY_URL
  590. app.state.config.YACY_USERNAME = YACY_USERNAME
  591. app.state.config.YACY_PASSWORD = YACY_PASSWORD
  592. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  593. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  594. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  595. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  596. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  597. app.state.config.BOCHA_SEARCH_API_KEY = BOCHA_SEARCH_API_KEY
  598. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  599. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  600. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  601. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  602. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  603. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  604. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  605. app.state.config.SERPAPI_API_KEY = SERPAPI_API_KEY
  606. app.state.config.SERPAPI_ENGINE = SERPAPI_ENGINE
  607. app.state.config.JINA_API_KEY = JINA_API_KEY
  608. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  609. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  610. app.state.config.EXA_API_KEY = EXA_API_KEY
  611. app.state.config.PERPLEXITY_API_KEY = PERPLEXITY_API_KEY
  612. app.state.config.SOUGOU_API_SID = SOUGOU_API_SID
  613. app.state.config.SOUGOU_API_SK = SOUGOU_API_SK
  614. app.state.config.EXTERNAL_WEB_SEARCH_URL = EXTERNAL_WEB_SEARCH_URL
  615. app.state.config.EXTERNAL_WEB_SEARCH_API_KEY = EXTERNAL_WEB_SEARCH_API_KEY
  616. app.state.config.EXTERNAL_WEB_LOADER_URL = EXTERNAL_WEB_LOADER_URL
  617. app.state.config.EXTERNAL_WEB_LOADER_API_KEY = EXTERNAL_WEB_LOADER_API_KEY
  618. app.state.config.PLAYWRIGHT_WS_URL = PLAYWRIGHT_WS_URL
  619. app.state.config.PLAYWRIGHT_TIMEOUT = PLAYWRIGHT_TIMEOUT
  620. app.state.config.FIRECRAWL_API_BASE_URL = FIRECRAWL_API_BASE_URL
  621. app.state.config.FIRECRAWL_API_KEY = FIRECRAWL_API_KEY
  622. app.state.config.TAVILY_EXTRACT_DEPTH = TAVILY_EXTRACT_DEPTH
  623. app.state.EMBEDDING_FUNCTION = None
  624. app.state.ef = None
  625. app.state.rf = None
  626. app.state.YOUTUBE_LOADER_TRANSLATION = None
  627. try:
  628. app.state.ef = get_ef(
  629. app.state.config.RAG_EMBEDDING_ENGINE,
  630. app.state.config.RAG_EMBEDDING_MODEL,
  631. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  632. )
  633. app.state.rf = get_rf(
  634. app.state.config.RAG_RERANKING_MODEL,
  635. RAG_RERANKING_MODEL_AUTO_UPDATE,
  636. )
  637. except Exception as e:
  638. log.error(f"Error updating models: {e}")
  639. pass
  640. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  641. app.state.config.RAG_EMBEDDING_ENGINE,
  642. app.state.config.RAG_EMBEDDING_MODEL,
  643. app.state.ef,
  644. (
  645. app.state.config.RAG_OPENAI_API_BASE_URL
  646. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  647. else app.state.config.RAG_OLLAMA_BASE_URL
  648. ),
  649. (
  650. app.state.config.RAG_OPENAI_API_KEY
  651. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  652. else app.state.config.RAG_OLLAMA_API_KEY
  653. ),
  654. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  655. )
  656. ########################################
  657. #
  658. # CODE EXECUTION
  659. #
  660. ########################################
  661. app.state.config.ENABLE_CODE_EXECUTION = ENABLE_CODE_EXECUTION
  662. app.state.config.CODE_EXECUTION_ENGINE = CODE_EXECUTION_ENGINE
  663. app.state.config.CODE_EXECUTION_JUPYTER_URL = CODE_EXECUTION_JUPYTER_URL
  664. app.state.config.CODE_EXECUTION_JUPYTER_AUTH = CODE_EXECUTION_JUPYTER_AUTH
  665. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_TOKEN = CODE_EXECUTION_JUPYTER_AUTH_TOKEN
  666. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_PASSWORD = (
  667. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD
  668. )
  669. app.state.config.CODE_EXECUTION_JUPYTER_TIMEOUT = CODE_EXECUTION_JUPYTER_TIMEOUT
  670. app.state.config.ENABLE_CODE_INTERPRETER = ENABLE_CODE_INTERPRETER
  671. app.state.config.CODE_INTERPRETER_ENGINE = CODE_INTERPRETER_ENGINE
  672. app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE = CODE_INTERPRETER_PROMPT_TEMPLATE
  673. app.state.config.CODE_INTERPRETER_JUPYTER_URL = CODE_INTERPRETER_JUPYTER_URL
  674. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH = CODE_INTERPRETER_JUPYTER_AUTH
  675. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_TOKEN = (
  676. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
  677. )
  678. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD = (
  679. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
  680. )
  681. app.state.config.CODE_INTERPRETER_JUPYTER_TIMEOUT = CODE_INTERPRETER_JUPYTER_TIMEOUT
  682. ########################################
  683. #
  684. # IMAGES
  685. #
  686. ########################################
  687. app.state.config.IMAGE_GENERATION_ENGINE = IMAGE_GENERATION_ENGINE
  688. app.state.config.ENABLE_IMAGE_GENERATION = ENABLE_IMAGE_GENERATION
  689. app.state.config.ENABLE_IMAGE_PROMPT_GENERATION = ENABLE_IMAGE_PROMPT_GENERATION
  690. app.state.config.IMAGES_OPENAI_API_BASE_URL = IMAGES_OPENAI_API_BASE_URL
  691. app.state.config.IMAGES_OPENAI_API_KEY = IMAGES_OPENAI_API_KEY
  692. app.state.config.IMAGES_GEMINI_API_BASE_URL = IMAGES_GEMINI_API_BASE_URL
  693. app.state.config.IMAGES_GEMINI_API_KEY = IMAGES_GEMINI_API_KEY
  694. app.state.config.IMAGE_GENERATION_MODEL = IMAGE_GENERATION_MODEL
  695. app.state.config.AUTOMATIC1111_BASE_URL = AUTOMATIC1111_BASE_URL
  696. app.state.config.AUTOMATIC1111_API_AUTH = AUTOMATIC1111_API_AUTH
  697. app.state.config.AUTOMATIC1111_CFG_SCALE = AUTOMATIC1111_CFG_SCALE
  698. app.state.config.AUTOMATIC1111_SAMPLER = AUTOMATIC1111_SAMPLER
  699. app.state.config.AUTOMATIC1111_SCHEDULER = AUTOMATIC1111_SCHEDULER
  700. app.state.config.COMFYUI_BASE_URL = COMFYUI_BASE_URL
  701. app.state.config.COMFYUI_API_KEY = COMFYUI_API_KEY
  702. app.state.config.COMFYUI_WORKFLOW = COMFYUI_WORKFLOW
  703. app.state.config.COMFYUI_WORKFLOW_NODES = COMFYUI_WORKFLOW_NODES
  704. app.state.config.IMAGE_SIZE = IMAGE_SIZE
  705. app.state.config.IMAGE_STEPS = IMAGE_STEPS
  706. ########################################
  707. #
  708. # AUDIO
  709. #
  710. ########################################
  711. app.state.config.STT_OPENAI_API_BASE_URL = AUDIO_STT_OPENAI_API_BASE_URL
  712. app.state.config.STT_OPENAI_API_KEY = AUDIO_STT_OPENAI_API_KEY
  713. app.state.config.STT_ENGINE = AUDIO_STT_ENGINE
  714. app.state.config.STT_MODEL = AUDIO_STT_MODEL
  715. app.state.config.WHISPER_MODEL = WHISPER_MODEL
  716. app.state.config.WHISPER_VAD_FILTER = WHISPER_VAD_FILTER
  717. app.state.config.DEEPGRAM_API_KEY = DEEPGRAM_API_KEY
  718. app.state.config.AUDIO_STT_AZURE_API_KEY = AUDIO_STT_AZURE_API_KEY
  719. app.state.config.AUDIO_STT_AZURE_REGION = AUDIO_STT_AZURE_REGION
  720. app.state.config.AUDIO_STT_AZURE_LOCALES = AUDIO_STT_AZURE_LOCALES
  721. app.state.config.AUDIO_STT_AZURE_BASE_URL = AUDIO_STT_AZURE_BASE_URL
  722. app.state.config.AUDIO_STT_AZURE_MAX_SPEAKERS = AUDIO_STT_AZURE_MAX_SPEAKERS
  723. app.state.config.TTS_OPENAI_API_BASE_URL = AUDIO_TTS_OPENAI_API_BASE_URL
  724. app.state.config.TTS_OPENAI_API_KEY = AUDIO_TTS_OPENAI_API_KEY
  725. app.state.config.TTS_ENGINE = AUDIO_TTS_ENGINE
  726. app.state.config.TTS_MODEL = AUDIO_TTS_MODEL
  727. app.state.config.TTS_VOICE = AUDIO_TTS_VOICE
  728. app.state.config.TTS_API_KEY = AUDIO_TTS_API_KEY
  729. app.state.config.TTS_SPLIT_ON = AUDIO_TTS_SPLIT_ON
  730. app.state.config.TTS_AZURE_SPEECH_REGION = AUDIO_TTS_AZURE_SPEECH_REGION
  731. app.state.config.TTS_AZURE_SPEECH_OUTPUT_FORMAT = AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
  732. app.state.faster_whisper_model = None
  733. app.state.speech_synthesiser = None
  734. app.state.speech_speaker_embeddings_dataset = None
  735. ########################################
  736. #
  737. # TASKS
  738. #
  739. ########################################
  740. app.state.config.TASK_MODEL = TASK_MODEL
  741. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  742. app.state.config.ENABLE_SEARCH_QUERY_GENERATION = ENABLE_SEARCH_QUERY_GENERATION
  743. app.state.config.ENABLE_RETRIEVAL_QUERY_GENERATION = ENABLE_RETRIEVAL_QUERY_GENERATION
  744. app.state.config.ENABLE_AUTOCOMPLETE_GENERATION = ENABLE_AUTOCOMPLETE_GENERATION
  745. app.state.config.ENABLE_TAGS_GENERATION = ENABLE_TAGS_GENERATION
  746. app.state.config.ENABLE_TITLE_GENERATION = ENABLE_TITLE_GENERATION
  747. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  748. app.state.config.TAGS_GENERATION_PROMPT_TEMPLATE = TAGS_GENERATION_PROMPT_TEMPLATE
  749. app.state.config.IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = (
  750. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
  751. )
  752. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  753. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  754. )
  755. app.state.config.QUERY_GENERATION_PROMPT_TEMPLATE = QUERY_GENERATION_PROMPT_TEMPLATE
  756. app.state.config.AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = (
  757. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
  758. )
  759. app.state.config.AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = (
  760. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
  761. )
  762. ########################################
  763. #
  764. # WEBUI
  765. #
  766. ########################################
  767. app.state.MODELS = {}
  768. class RedirectMiddleware(BaseHTTPMiddleware):
  769. async def dispatch(self, request: Request, call_next):
  770. # Check if the request is a GET request
  771. if request.method == "GET":
  772. path = request.url.path
  773. query_params = dict(parse_qs(urlparse(str(request.url)).query))
  774. # Check for the specific watch path and the presence of 'v' parameter
  775. if path.endswith("/watch") and "v" in query_params:
  776. # Extract the first 'v' parameter
  777. video_id = query_params["v"][0]
  778. encoded_video_id = urlencode({"youtube": video_id})
  779. redirect_url = f"/?{encoded_video_id}"
  780. return RedirectResponse(url=redirect_url)
  781. # Proceed with the normal flow of other requests
  782. response = await call_next(request)
  783. return response
  784. # Add the middleware to the app
  785. app.add_middleware(RedirectMiddleware)
  786. app.add_middleware(SecurityHeadersMiddleware)
  787. @app.middleware("http")
  788. async def commit_session_after_request(request: Request, call_next):
  789. response = await call_next(request)
  790. # log.debug("Commit session after request")
  791. Session.commit()
  792. return response
  793. @app.middleware("http")
  794. async def check_url(request: Request, call_next):
  795. start_time = int(time.time())
  796. request.state.token = get_http_authorization_cred(
  797. request.headers.get("Authorization")
  798. )
  799. request.state.enable_api_key = app.state.config.ENABLE_API_KEY
  800. response = await call_next(request)
  801. process_time = int(time.time()) - start_time
  802. response.headers["X-Process-Time"] = str(process_time)
  803. return response
  804. @app.middleware("http")
  805. async def inspect_websocket(request: Request, call_next):
  806. if (
  807. "/ws/socket.io" in request.url.path
  808. and request.query_params.get("transport") == "websocket"
  809. ):
  810. upgrade = (request.headers.get("Upgrade") or "").lower()
  811. connection = (request.headers.get("Connection") or "").lower().split(",")
  812. # Check that there's the correct headers for an upgrade, else reject the connection
  813. # This is to work around this upstream issue: https://github.com/miguelgrinberg/python-engineio/issues/367
  814. if upgrade != "websocket" or "upgrade" not in connection:
  815. return JSONResponse(
  816. status_code=status.HTTP_400_BAD_REQUEST,
  817. content={"detail": "Invalid WebSocket upgrade request"},
  818. )
  819. return await call_next(request)
  820. app.add_middleware(
  821. CORSMiddleware,
  822. allow_origins=CORS_ALLOW_ORIGIN,
  823. allow_credentials=True,
  824. allow_methods=["*"],
  825. allow_headers=["*"],
  826. )
  827. app.mount("/ws", socket_app)
  828. app.include_router(ollama.router, prefix="/ollama", tags=["ollama"])
  829. app.include_router(openai.router, prefix="/openai", tags=["openai"])
  830. app.include_router(pipelines.router, prefix="/api/v1/pipelines", tags=["pipelines"])
  831. app.include_router(tasks.router, prefix="/api/v1/tasks", tags=["tasks"])
  832. app.include_router(images.router, prefix="/api/v1/images", tags=["images"])
  833. app.include_router(audio.router, prefix="/api/v1/audio", tags=["audio"])
  834. app.include_router(retrieval.router, prefix="/api/v1/retrieval", tags=["retrieval"])
  835. app.include_router(configs.router, prefix="/api/v1/configs", tags=["configs"])
  836. app.include_router(auths.router, prefix="/api/v1/auths", tags=["auths"])
  837. app.include_router(users.router, prefix="/api/v1/users", tags=["users"])
  838. app.include_router(channels.router, prefix="/api/v1/channels", tags=["channels"])
  839. app.include_router(chats.router, prefix="/api/v1/chats", tags=["chats"])
  840. app.include_router(models.router, prefix="/api/v1/models", tags=["models"])
  841. app.include_router(knowledge.router, prefix="/api/v1/knowledge", tags=["knowledge"])
  842. app.include_router(prompts.router, prefix="/api/v1/prompts", tags=["prompts"])
  843. app.include_router(tools.router, prefix="/api/v1/tools", tags=["tools"])
  844. app.include_router(memories.router, prefix="/api/v1/memories", tags=["memories"])
  845. app.include_router(folders.router, prefix="/api/v1/folders", tags=["folders"])
  846. app.include_router(groups.router, prefix="/api/v1/groups", tags=["groups"])
  847. app.include_router(files.router, prefix="/api/v1/files", tags=["files"])
  848. app.include_router(functions.router, prefix="/api/v1/functions", tags=["functions"])
  849. app.include_router(
  850. evaluations.router, prefix="/api/v1/evaluations", tags=["evaluations"]
  851. )
  852. app.include_router(utils.router, prefix="/api/v1/utils", tags=["utils"])
  853. try:
  854. audit_level = AuditLevel(AUDIT_LOG_LEVEL)
  855. except ValueError as e:
  856. logger.error(f"Invalid audit level: {AUDIT_LOG_LEVEL}. Error: {e}")
  857. audit_level = AuditLevel.NONE
  858. if audit_level != AuditLevel.NONE:
  859. app.add_middleware(
  860. AuditLoggingMiddleware,
  861. audit_level=audit_level,
  862. excluded_paths=AUDIT_EXCLUDED_PATHS,
  863. max_body_size=MAX_BODY_LOG_SIZE,
  864. )
  865. ##################################
  866. #
  867. # Chat Endpoints
  868. #
  869. ##################################
  870. @app.get("/api/models")
  871. async def get_models(request: Request, user=Depends(get_verified_user)):
  872. def get_filtered_models(models, user):
  873. filtered_models = []
  874. for model in models:
  875. if model.get("arena"):
  876. if has_access(
  877. user.id,
  878. type="read",
  879. access_control=model.get("info", {})
  880. .get("meta", {})
  881. .get("access_control", {}),
  882. ):
  883. filtered_models.append(model)
  884. continue
  885. model_info = Models.get_model_by_id(model["id"])
  886. if model_info:
  887. if user.id == model_info.user_id or has_access(
  888. user.id, type="read", access_control=model_info.access_control
  889. ):
  890. filtered_models.append(model)
  891. return filtered_models
  892. all_models = await get_all_models(request, user=user)
  893. models = []
  894. for model in all_models:
  895. # Filter out filter pipelines
  896. if "pipeline" in model and model["pipeline"].get("type", None) == "filter":
  897. continue
  898. try:
  899. model_tags = [
  900. tag.get("name")
  901. for tag in model.get("info", {}).get("meta", {}).get("tags", [])
  902. ]
  903. tags = [tag.get("name") for tag in model.get("tags", [])]
  904. tags = list(set(model_tags + tags))
  905. model["tags"] = [{"name": tag} for tag in tags]
  906. except Exception as e:
  907. log.debug(f"Error processing model tags: {e}")
  908. model["tags"] = []
  909. pass
  910. models.append(model)
  911. model_order_list = request.app.state.config.MODEL_ORDER_LIST
  912. if model_order_list:
  913. model_order_dict = {model_id: i for i, model_id in enumerate(model_order_list)}
  914. # Sort models by order list priority, with fallback for those not in the list
  915. models.sort(
  916. key=lambda x: (model_order_dict.get(x["id"], float("inf")), x["name"])
  917. )
  918. # Filter out models that the user does not have access to
  919. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  920. models = get_filtered_models(models, user)
  921. log.debug(
  922. f"/api/models returned filtered models accessible to the user: {json.dumps([model['id'] for model in models])}"
  923. )
  924. return {"data": models}
  925. @app.get("/api/models/base")
  926. async def get_base_models(request: Request, user=Depends(get_admin_user)):
  927. models = await get_all_base_models(request, user=user)
  928. return {"data": models}
  929. @app.post("/api/chat/completions")
  930. async def chat_completion(
  931. request: Request,
  932. form_data: dict,
  933. user=Depends(get_verified_user),
  934. ):
  935. if not request.app.state.MODELS:
  936. await get_all_models(request, user=user)
  937. model_item = form_data.pop("model_item", {})
  938. tasks = form_data.pop("background_tasks", None)
  939. metadata = {}
  940. try:
  941. if not model_item.get("direct", False):
  942. model_id = form_data.get("model", None)
  943. if model_id not in request.app.state.MODELS:
  944. raise Exception("Model not found")
  945. model = request.app.state.MODELS[model_id]
  946. model_info = Models.get_model_by_id(model_id)
  947. # Check if user has access to the model
  948. if not BYPASS_MODEL_ACCESS_CONTROL and user.role == "user":
  949. try:
  950. check_model_access(user, model)
  951. except Exception as e:
  952. raise e
  953. else:
  954. model = model_item
  955. model_info = None
  956. request.state.direct = True
  957. request.state.model = model
  958. metadata = {
  959. "user_id": user.id,
  960. "chat_id": form_data.pop("chat_id", None),
  961. "message_id": form_data.pop("id", None),
  962. "session_id": form_data.pop("session_id", None),
  963. "tool_ids": form_data.get("tool_ids", None),
  964. "tool_servers": form_data.pop("tool_servers", None),
  965. "files": form_data.get("files", None),
  966. "features": form_data.get("features", None),
  967. "variables": form_data.get("variables", None),
  968. "model": model,
  969. "direct": model_item.get("direct", False),
  970. **(
  971. {"function_calling": "native"}
  972. if form_data.get("params", {}).get("function_calling") == "native"
  973. or (
  974. model_info
  975. and model_info.params.model_dump().get("function_calling")
  976. == "native"
  977. )
  978. else {}
  979. ),
  980. }
  981. request.state.metadata = metadata
  982. form_data["metadata"] = metadata
  983. form_data, metadata, events = await process_chat_payload(
  984. request, form_data, user, metadata, model
  985. )
  986. except Exception as e:
  987. log.debug(f"Error processing chat payload: {e}")
  988. if metadata.get("chat_id") and metadata.get("message_id"):
  989. # Update the chat message with the error
  990. Chats.upsert_message_to_chat_by_id_and_message_id(
  991. metadata["chat_id"],
  992. metadata["message_id"],
  993. {
  994. "error": {"content": str(e)},
  995. },
  996. )
  997. raise HTTPException(
  998. status_code=status.HTTP_400_BAD_REQUEST,
  999. detail=str(e),
  1000. )
  1001. try:
  1002. response = await chat_completion_handler(request, form_data, user)
  1003. return await process_chat_response(
  1004. request, response, form_data, user, metadata, model, events, tasks
  1005. )
  1006. except Exception as e:
  1007. raise HTTPException(
  1008. status_code=status.HTTP_400_BAD_REQUEST,
  1009. detail=str(e),
  1010. )
  1011. # Alias for chat_completion (Legacy)
  1012. generate_chat_completions = chat_completion
  1013. generate_chat_completion = chat_completion
  1014. @app.post("/api/chat/completed")
  1015. async def chat_completed(
  1016. request: Request, form_data: dict, user=Depends(get_verified_user)
  1017. ):
  1018. try:
  1019. model_item = form_data.pop("model_item", {})
  1020. if model_item.get("direct", False):
  1021. request.state.direct = True
  1022. request.state.model = model_item
  1023. return await chat_completed_handler(request, form_data, user)
  1024. except Exception as e:
  1025. raise HTTPException(
  1026. status_code=status.HTTP_400_BAD_REQUEST,
  1027. detail=str(e),
  1028. )
  1029. @app.post("/api/chat/actions/{action_id}")
  1030. async def chat_action(
  1031. request: Request, action_id: str, form_data: dict, user=Depends(get_verified_user)
  1032. ):
  1033. try:
  1034. model_item = form_data.pop("model_item", {})
  1035. if model_item.get("direct", False):
  1036. request.state.direct = True
  1037. request.state.model = model_item
  1038. return await chat_action_handler(request, action_id, form_data, user)
  1039. except Exception as e:
  1040. raise HTTPException(
  1041. status_code=status.HTTP_400_BAD_REQUEST,
  1042. detail=str(e),
  1043. )
  1044. @app.post("/api/tasks/stop/{task_id}")
  1045. async def stop_task_endpoint(task_id: str, user=Depends(get_verified_user)):
  1046. try:
  1047. result = await stop_task(task_id)
  1048. return result
  1049. except ValueError as e:
  1050. raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
  1051. @app.get("/api/tasks")
  1052. async def list_tasks_endpoint(user=Depends(get_verified_user)):
  1053. return {"tasks": list_tasks()}
  1054. @app.get("/api/tasks/chat/{chat_id}")
  1055. async def list_tasks_by_chat_id_endpoint(chat_id: str, user=Depends(get_verified_user)):
  1056. chat = Chats.get_chat_by_id(chat_id)
  1057. if chat is None or chat.user_id != user.id:
  1058. return {"task_ids": []}
  1059. task_ids = list_task_ids_by_chat_id(chat_id)
  1060. print(f"Task IDs for chat {chat_id}: {task_ids}")
  1061. return {"task_ids": task_ids}
  1062. ##################################
  1063. #
  1064. # Config Endpoints
  1065. #
  1066. ##################################
  1067. @app.get("/api/config")
  1068. async def get_app_config(request: Request):
  1069. user = None
  1070. if "token" in request.cookies:
  1071. token = request.cookies.get("token")
  1072. try:
  1073. data = decode_token(token)
  1074. except Exception as e:
  1075. log.debug(e)
  1076. raise HTTPException(
  1077. status_code=status.HTTP_401_UNAUTHORIZED,
  1078. detail="Invalid token",
  1079. )
  1080. if data is not None and "id" in data:
  1081. user = Users.get_user_by_id(data["id"])
  1082. user_count = Users.get_num_users()
  1083. onboarding = False
  1084. if user is None:
  1085. onboarding = user_count == 0
  1086. return {
  1087. **({"onboarding": True} if onboarding else {}),
  1088. "status": True,
  1089. "name": app.state.WEBUI_NAME,
  1090. "version": VERSION,
  1091. "default_locale": str(DEFAULT_LOCALE),
  1092. "oauth": {
  1093. "providers": {
  1094. name: config.get("name", name)
  1095. for name, config in OAUTH_PROVIDERS.items()
  1096. }
  1097. },
  1098. "features": {
  1099. "auth": WEBUI_AUTH,
  1100. "auth_trusted_header": bool(app.state.AUTH_TRUSTED_EMAIL_HEADER),
  1101. "enable_ldap": app.state.config.ENABLE_LDAP,
  1102. "enable_api_key": app.state.config.ENABLE_API_KEY,
  1103. "enable_signup": app.state.config.ENABLE_SIGNUP,
  1104. "enable_login_form": app.state.config.ENABLE_LOGIN_FORM,
  1105. "enable_websocket": ENABLE_WEBSOCKET_SUPPORT,
  1106. **(
  1107. {
  1108. "enable_direct_connections": app.state.config.ENABLE_DIRECT_CONNECTIONS,
  1109. "enable_channels": app.state.config.ENABLE_CHANNELS,
  1110. "enable_web_search": app.state.config.ENABLE_WEB_SEARCH,
  1111. "enable_code_execution": app.state.config.ENABLE_CODE_EXECUTION,
  1112. "enable_code_interpreter": app.state.config.ENABLE_CODE_INTERPRETER,
  1113. "enable_image_generation": app.state.config.ENABLE_IMAGE_GENERATION,
  1114. "enable_autocomplete_generation": app.state.config.ENABLE_AUTOCOMPLETE_GENERATION,
  1115. "enable_community_sharing": app.state.config.ENABLE_COMMUNITY_SHARING,
  1116. "enable_message_rating": app.state.config.ENABLE_MESSAGE_RATING,
  1117. "enable_user_webhooks": app.state.config.ENABLE_USER_WEBHOOKS,
  1118. "enable_admin_export": ENABLE_ADMIN_EXPORT,
  1119. "enable_admin_chat_access": ENABLE_ADMIN_CHAT_ACCESS,
  1120. "enable_google_drive_integration": app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION,
  1121. "enable_onedrive_integration": app.state.config.ENABLE_ONEDRIVE_INTEGRATION,
  1122. }
  1123. if user is not None
  1124. else {}
  1125. ),
  1126. },
  1127. **(
  1128. {
  1129. "default_models": app.state.config.DEFAULT_MODELS,
  1130. "default_prompt_suggestions": app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
  1131. "user_count": user_count,
  1132. "code": {
  1133. "engine": app.state.config.CODE_EXECUTION_ENGINE,
  1134. },
  1135. "audio": {
  1136. "tts": {
  1137. "engine": app.state.config.TTS_ENGINE,
  1138. "voice": app.state.config.TTS_VOICE,
  1139. "split_on": app.state.config.TTS_SPLIT_ON,
  1140. },
  1141. "stt": {
  1142. "engine": app.state.config.STT_ENGINE,
  1143. },
  1144. },
  1145. "file": {
  1146. "max_size": app.state.config.FILE_MAX_SIZE,
  1147. "max_count": app.state.config.FILE_MAX_COUNT,
  1148. },
  1149. "permissions": {**app.state.config.USER_PERMISSIONS},
  1150. "google_drive": {
  1151. "client_id": GOOGLE_DRIVE_CLIENT_ID.value,
  1152. "api_key": GOOGLE_DRIVE_API_KEY.value,
  1153. },
  1154. "onedrive": {
  1155. "client_id": ONEDRIVE_CLIENT_ID.value,
  1156. "sharepoint_url": ONEDRIVE_SHAREPOINT_URL.value,
  1157. },
  1158. "license_metadata": app.state.LICENSE_METADATA,
  1159. **(
  1160. {
  1161. "active_entries": app.state.USER_COUNT,
  1162. }
  1163. if user.role == "admin"
  1164. else {}
  1165. ),
  1166. }
  1167. if user is not None
  1168. else {}
  1169. ),
  1170. }
  1171. class UrlForm(BaseModel):
  1172. url: str
  1173. @app.get("/api/webhook")
  1174. async def get_webhook_url(user=Depends(get_admin_user)):
  1175. return {
  1176. "url": app.state.config.WEBHOOK_URL,
  1177. }
  1178. @app.post("/api/webhook")
  1179. async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
  1180. app.state.config.WEBHOOK_URL = form_data.url
  1181. app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
  1182. return {"url": app.state.config.WEBHOOK_URL}
  1183. @app.get("/api/version")
  1184. async def get_app_version():
  1185. return {
  1186. "version": VERSION,
  1187. }
  1188. @app.get("/api/version/updates")
  1189. async def get_app_latest_release_version(user=Depends(get_verified_user)):
  1190. if OFFLINE_MODE:
  1191. log.debug(
  1192. f"Offline mode is enabled, returning current version as latest version"
  1193. )
  1194. return {"current": VERSION, "latest": VERSION}
  1195. try:
  1196. timeout = aiohttp.ClientTimeout(total=1)
  1197. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  1198. async with session.get(
  1199. "https://api.github.com/repos/open-webui/open-webui/releases/latest"
  1200. ) as response:
  1201. response.raise_for_status()
  1202. data = await response.json()
  1203. latest_version = data["tag_name"]
  1204. return {"current": VERSION, "latest": latest_version[1:]}
  1205. except Exception as e:
  1206. log.debug(e)
  1207. return {"current": VERSION, "latest": VERSION}
  1208. @app.get("/api/changelog")
  1209. async def get_app_changelog():
  1210. return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
  1211. ############################
  1212. # OAuth Login & Callback
  1213. ############################
  1214. # SessionMiddleware is used by authlib for oauth
  1215. if len(OAUTH_PROVIDERS) > 0:
  1216. app.add_middleware(
  1217. SessionMiddleware,
  1218. secret_key=WEBUI_SECRET_KEY,
  1219. session_cookie="oui-session",
  1220. same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  1221. https_only=WEBUI_SESSION_COOKIE_SECURE,
  1222. )
  1223. @app.get("/oauth/{provider}/login")
  1224. async def oauth_login(provider: str, request: Request):
  1225. return await oauth_manager.handle_login(request, provider)
  1226. # OAuth login logic is as follows:
  1227. # 1. Attempt to find a user with matching subject ID, tied to the provider
  1228. # 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
  1229. # - This is considered insecure in general, as OAuth providers do not always verify email addresses
  1230. # 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
  1231. # - Email addresses are considered unique, so we fail registration if the email address is already taken
  1232. @app.get("/oauth/{provider}/callback")
  1233. async def oauth_callback(provider: str, request: Request, response: Response):
  1234. return await oauth_manager.handle_callback(request, provider, response)
  1235. @app.get("/manifest.json")
  1236. async def get_manifest_json():
  1237. if app.state.EXTERNAL_PWA_MANIFEST_URL:
  1238. return requests.get(app.state.EXTERNAL_PWA_MANIFEST_URL).json()
  1239. else:
  1240. return {
  1241. "name": app.state.WEBUI_NAME,
  1242. "short_name": app.state.WEBUI_NAME,
  1243. "description": "Open WebUI is an open, extensible, user-friendly interface for AI that adapts to your workflow.",
  1244. "start_url": "/",
  1245. "display": "standalone",
  1246. "background_color": "#343541",
  1247. "orientation": "any",
  1248. "icons": [
  1249. {
  1250. "src": "/static/logo.png",
  1251. "type": "image/png",
  1252. "sizes": "500x500",
  1253. "purpose": "any",
  1254. },
  1255. {
  1256. "src": "/static/logo.png",
  1257. "type": "image/png",
  1258. "sizes": "500x500",
  1259. "purpose": "maskable",
  1260. },
  1261. ],
  1262. }
  1263. @app.get("/opensearch.xml")
  1264. async def get_opensearch_xml():
  1265. xml_content = rf"""
  1266. <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  1267. <ShortName>{app.state.WEBUI_NAME}</ShortName>
  1268. <Description>Search {app.state.WEBUI_NAME}</Description>
  1269. <InputEncoding>UTF-8</InputEncoding>
  1270. <Image width="16" height="16" type="image/x-icon">{app.state.config.WEBUI_URL}/static/favicon.png</Image>
  1271. <Url type="text/html" method="get" template="{app.state.config.WEBUI_URL}/?q={"{searchTerms}"}"/>
  1272. <moz:SearchForm>{app.state.config.WEBUI_URL}</moz:SearchForm>
  1273. </OpenSearchDescription>
  1274. """
  1275. return Response(content=xml_content, media_type="application/xml")
  1276. @app.get("/health")
  1277. async def healthcheck():
  1278. return {"status": True}
  1279. @app.get("/health/db")
  1280. async def healthcheck_with_db():
  1281. Session.execute(text("SELECT 1;")).all()
  1282. return {"status": True}
  1283. app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
  1284. app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
  1285. def swagger_ui_html(*args, **kwargs):
  1286. return get_swagger_ui_html(
  1287. *args,
  1288. **kwargs,
  1289. swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
  1290. swagger_css_url="/static/swagger-ui/swagger-ui.css",
  1291. swagger_favicon_url="/static/swagger-ui/favicon.png",
  1292. )
  1293. applications.get_swagger_ui_html = swagger_ui_html
  1294. if os.path.exists(FRONTEND_BUILD_DIR):
  1295. mimetypes.add_type("text/javascript", ".js")
  1296. app.mount(
  1297. "/",
  1298. SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
  1299. name="spa-static-files",
  1300. )
  1301. else:
  1302. log.warning(
  1303. f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
  1304. )