main.py 51 KB

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