main.py 51 KB

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