main.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137
  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 requests
  19. from fastapi import (
  20. Depends,
  21. FastAPI,
  22. File,
  23. Form,
  24. HTTPException,
  25. Request,
  26. UploadFile,
  27. status,
  28. applications,
  29. )
  30. from fastapi.openapi.docs import get_swagger_ui_html
  31. from fastapi.middleware.cors import CORSMiddleware
  32. from fastapi.responses import JSONResponse, RedirectResponse
  33. from fastapi.staticfiles import StaticFiles
  34. from starlette.exceptions import HTTPException as StarletteHTTPException
  35. from starlette.middleware.base import BaseHTTPMiddleware
  36. from starlette.middleware.sessions import SessionMiddleware
  37. from starlette.responses import Response, StreamingResponse
  38. from open_webui.socket.main import (
  39. app as socket_app,
  40. periodic_usage_pool_cleanup,
  41. )
  42. from open_webui.routers import (
  43. audio,
  44. images,
  45. ollama,
  46. openai,
  47. retrieval,
  48. pipelines,
  49. tasks,
  50. auths,
  51. chats,
  52. folders,
  53. configs,
  54. groups,
  55. files,
  56. functions,
  57. memories,
  58. models,
  59. knowledge,
  60. prompts,
  61. evaluations,
  62. tools,
  63. users,
  64. utils,
  65. )
  66. from open_webui.routers.retrieval import (
  67. get_embedding_function,
  68. get_ef,
  69. get_rf,
  70. )
  71. from open_webui.internal.db import Session
  72. from open_webui.models.functions import Functions
  73. from open_webui.models.models import Models
  74. from open_webui.models.users import UserModel, Users
  75. from open_webui.config import (
  76. # Ollama
  77. ENABLE_OLLAMA_API,
  78. OLLAMA_BASE_URLS,
  79. OLLAMA_API_CONFIGS,
  80. # OpenAI
  81. ENABLE_OPENAI_API,
  82. OPENAI_API_BASE_URLS,
  83. OPENAI_API_KEYS,
  84. OPENAI_API_CONFIGS,
  85. # Image
  86. AUTOMATIC1111_API_AUTH,
  87. AUTOMATIC1111_BASE_URL,
  88. AUTOMATIC1111_CFG_SCALE,
  89. AUTOMATIC1111_SAMPLER,
  90. AUTOMATIC1111_SCHEDULER,
  91. COMFYUI_BASE_URL,
  92. COMFYUI_API_KEY,
  93. COMFYUI_WORKFLOW,
  94. COMFYUI_WORKFLOW_NODES,
  95. ENABLE_IMAGE_GENERATION,
  96. IMAGE_GENERATION_ENGINE,
  97. IMAGE_GENERATION_MODEL,
  98. IMAGE_SIZE,
  99. IMAGE_STEPS,
  100. IMAGES_OPENAI_API_BASE_URL,
  101. IMAGES_OPENAI_API_KEY,
  102. # Audio
  103. AUDIO_STT_ENGINE,
  104. AUDIO_STT_MODEL,
  105. AUDIO_STT_OPENAI_API_BASE_URL,
  106. AUDIO_STT_OPENAI_API_KEY,
  107. AUDIO_TTS_API_KEY,
  108. AUDIO_TTS_ENGINE,
  109. AUDIO_TTS_MODEL,
  110. AUDIO_TTS_OPENAI_API_BASE_URL,
  111. AUDIO_TTS_OPENAI_API_KEY,
  112. AUDIO_TTS_SPLIT_ON,
  113. AUDIO_TTS_VOICE,
  114. AUDIO_TTS_AZURE_SPEECH_REGION,
  115. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT,
  116. WHISPER_MODEL,
  117. WHISPER_MODEL_AUTO_UPDATE,
  118. WHISPER_MODEL_DIR,
  119. # Retrieval
  120. RAG_TEMPLATE,
  121. DEFAULT_RAG_TEMPLATE,
  122. RAG_EMBEDDING_MODEL,
  123. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  124. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  125. RAG_RERANKING_MODEL,
  126. RAG_RERANKING_MODEL_AUTO_UPDATE,
  127. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  128. RAG_EMBEDDING_ENGINE,
  129. RAG_EMBEDDING_BATCH_SIZE,
  130. RAG_RELEVANCE_THRESHOLD,
  131. RAG_FILE_MAX_COUNT,
  132. RAG_FILE_MAX_SIZE,
  133. RAG_OPENAI_API_BASE_URL,
  134. RAG_OPENAI_API_KEY,
  135. RAG_OLLAMA_BASE_URL,
  136. RAG_OLLAMA_API_KEY,
  137. CHUNK_OVERLAP,
  138. CHUNK_SIZE,
  139. CONTENT_EXTRACTION_ENGINE,
  140. TIKA_SERVER_URL,
  141. RAG_TOP_K,
  142. RAG_TEXT_SPLITTER,
  143. TIKTOKEN_ENCODING_NAME,
  144. PDF_EXTRACT_IMAGES,
  145. YOUTUBE_LOADER_LANGUAGE,
  146. YOUTUBE_LOADER_PROXY_URL,
  147. # Retrieval (Web Search)
  148. RAG_WEB_SEARCH_ENGINE,
  149. RAG_WEB_SEARCH_RESULT_COUNT,
  150. RAG_WEB_SEARCH_CONCURRENT_REQUESTS,
  151. RAG_WEB_SEARCH_DOMAIN_FILTER_LIST,
  152. JINA_API_KEY,
  153. SEARCHAPI_API_KEY,
  154. SEARCHAPI_ENGINE,
  155. SEARXNG_QUERY_URL,
  156. SERPER_API_KEY,
  157. SERPLY_API_KEY,
  158. SERPSTACK_API_KEY,
  159. SERPSTACK_HTTPS,
  160. TAVILY_API_KEY,
  161. BING_SEARCH_V7_ENDPOINT,
  162. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  163. BRAVE_SEARCH_API_KEY,
  164. KAGI_SEARCH_API_KEY,
  165. MOJEEK_SEARCH_API_KEY,
  166. GOOGLE_PSE_API_KEY,
  167. GOOGLE_PSE_ENGINE_ID,
  168. ENABLE_RAG_HYBRID_SEARCH,
  169. ENABLE_RAG_LOCAL_WEB_FETCH,
  170. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION,
  171. ENABLE_RAG_WEB_SEARCH,
  172. UPLOAD_DIR,
  173. # WebUI
  174. WEBUI_AUTH,
  175. WEBUI_NAME,
  176. WEBUI_BANNERS,
  177. WEBHOOK_URL,
  178. ADMIN_EMAIL,
  179. SHOW_ADMIN_DETAILS,
  180. JWT_EXPIRES_IN,
  181. ENABLE_SIGNUP,
  182. ENABLE_LOGIN_FORM,
  183. ENABLE_API_KEY,
  184. ENABLE_COMMUNITY_SHARING,
  185. ENABLE_MESSAGE_RATING,
  186. ENABLE_EVALUATION_ARENA_MODELS,
  187. USER_PERMISSIONS,
  188. DEFAULT_USER_ROLE,
  189. DEFAULT_PROMPT_SUGGESTIONS,
  190. DEFAULT_MODELS,
  191. DEFAULT_ARENA_MODEL,
  192. MODEL_ORDER_LIST,
  193. EVALUATION_ARENA_MODELS,
  194. # WebUI (OAuth)
  195. ENABLE_OAUTH_ROLE_MANAGEMENT,
  196. OAUTH_ROLES_CLAIM,
  197. OAUTH_EMAIL_CLAIM,
  198. OAUTH_PICTURE_CLAIM,
  199. OAUTH_USERNAME_CLAIM,
  200. OAUTH_ALLOWED_ROLES,
  201. OAUTH_ADMIN_ROLES,
  202. # WebUI (LDAP)
  203. ENABLE_LDAP,
  204. LDAP_SERVER_LABEL,
  205. LDAP_SERVER_HOST,
  206. LDAP_SERVER_PORT,
  207. LDAP_ATTRIBUTE_FOR_USERNAME,
  208. LDAP_SEARCH_FILTERS,
  209. LDAP_SEARCH_BASE,
  210. LDAP_APP_DN,
  211. LDAP_APP_PASSWORD,
  212. LDAP_USE_TLS,
  213. LDAP_CA_CERT_FILE,
  214. LDAP_CIPHERS,
  215. # Misc
  216. ENV,
  217. CACHE_DIR,
  218. STATIC_DIR,
  219. FRONTEND_BUILD_DIR,
  220. CORS_ALLOW_ORIGIN,
  221. DEFAULT_LOCALE,
  222. OAUTH_PROVIDERS,
  223. # Admin
  224. ENABLE_ADMIN_CHAT_ACCESS,
  225. ENABLE_ADMIN_EXPORT,
  226. # Tasks
  227. TASK_MODEL,
  228. TASK_MODEL_EXTERNAL,
  229. ENABLE_TAGS_GENERATION,
  230. ENABLE_SEARCH_QUERY_GENERATION,
  231. ENABLE_RETRIEVAL_QUERY_GENERATION,
  232. ENABLE_AUTOCOMPLETE_GENERATION,
  233. TITLE_GENERATION_PROMPT_TEMPLATE,
  234. TAGS_GENERATION_PROMPT_TEMPLATE,
  235. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  236. QUERY_GENERATION_PROMPT_TEMPLATE,
  237. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE,
  238. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH,
  239. AppConfig,
  240. reset_config,
  241. )
  242. from open_webui.env import (
  243. CHANGELOG,
  244. GLOBAL_LOG_LEVEL,
  245. SAFE_MODE,
  246. SRC_LOG_LEVELS,
  247. VERSION,
  248. WEBUI_URL,
  249. WEBUI_BUILD_HASH,
  250. WEBUI_SECRET_KEY,
  251. WEBUI_SESSION_COOKIE_SAME_SITE,
  252. WEBUI_SESSION_COOKIE_SECURE,
  253. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  254. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  255. BYPASS_MODEL_ACCESS_CONTROL,
  256. RESET_CONFIG_ON_START,
  257. OFFLINE_MODE,
  258. )
  259. from open_webui.utils.models import (
  260. get_all_models,
  261. get_all_base_models,
  262. check_model_access,
  263. )
  264. from open_webui.utils.chat import (
  265. generate_chat_completion as chat_completion_handler,
  266. chat_completed as chat_completed_handler,
  267. chat_action as chat_action_handler,
  268. )
  269. from open_webui.utils.middleware import process_chat_payload, process_chat_response
  270. from open_webui.utils.access_control import has_access
  271. from open_webui.utils.auth import (
  272. decode_token,
  273. get_admin_user,
  274. get_verified_user,
  275. )
  276. from open_webui.utils.oauth import oauth_manager
  277. from open_webui.utils.security_headers import SecurityHeadersMiddleware
  278. if SAFE_MODE:
  279. print("SAFE MODE ENABLED")
  280. Functions.deactivate_all_functions()
  281. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  282. log = logging.getLogger(__name__)
  283. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  284. class SPAStaticFiles(StaticFiles):
  285. async def get_response(self, path: str, scope):
  286. try:
  287. return await super().get_response(path, scope)
  288. except (HTTPException, StarletteHTTPException) as ex:
  289. if ex.status_code == 404:
  290. return await super().get_response("index.html", scope)
  291. else:
  292. raise ex
  293. print(
  294. rf"""
  295. ___ __ __ _ _ _ ___
  296. / _ \ _ __ ___ _ __ \ \ / /__| |__ | | | |_ _|
  297. | | | | '_ \ / _ \ '_ \ \ \ /\ / / _ \ '_ \| | | || |
  298. | |_| | |_) | __/ | | | \ V V / __/ |_) | |_| || |
  299. \___/| .__/ \___|_| |_| \_/\_/ \___|_.__/ \___/|___|
  300. |_|
  301. v{VERSION} - building the best open-source AI user interface.
  302. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  303. https://github.com/open-webui/open-webui
  304. """
  305. )
  306. @asynccontextmanager
  307. async def lifespan(app: FastAPI):
  308. if RESET_CONFIG_ON_START:
  309. reset_config()
  310. asyncio.create_task(periodic_usage_pool_cleanup())
  311. yield
  312. app = FastAPI(
  313. docs_url="/docs" if ENV == "dev" else None,
  314. openapi_url="/openapi.json" if ENV == "dev" else None,
  315. redoc_url=None,
  316. lifespan=lifespan,
  317. )
  318. app.state.config = AppConfig()
  319. ########################################
  320. #
  321. # OLLAMA
  322. #
  323. ########################################
  324. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  325. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  326. app.state.config.OLLAMA_API_CONFIGS = OLLAMA_API_CONFIGS
  327. app.state.OLLAMA_MODELS = {}
  328. ########################################
  329. #
  330. # OPENAI
  331. #
  332. ########################################
  333. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  334. app.state.config.OPENAI_API_BASE_URLS = OPENAI_API_BASE_URLS
  335. app.state.config.OPENAI_API_KEYS = OPENAI_API_KEYS
  336. app.state.config.OPENAI_API_CONFIGS = OPENAI_API_CONFIGS
  337. app.state.OPENAI_MODELS = {}
  338. ########################################
  339. #
  340. # WEBUI
  341. #
  342. ########################################
  343. app.state.config.ENABLE_SIGNUP = ENABLE_SIGNUP
  344. app.state.config.ENABLE_LOGIN_FORM = ENABLE_LOGIN_FORM
  345. app.state.config.ENABLE_API_KEY = ENABLE_API_KEY
  346. app.state.config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  347. app.state.config.SHOW_ADMIN_DETAILS = SHOW_ADMIN_DETAILS
  348. app.state.config.ADMIN_EMAIL = ADMIN_EMAIL
  349. app.state.config.DEFAULT_MODELS = DEFAULT_MODELS
  350. app.state.config.DEFAULT_PROMPT_SUGGESTIONS = DEFAULT_PROMPT_SUGGESTIONS
  351. app.state.config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  352. app.state.config.USER_PERMISSIONS = USER_PERMISSIONS
  353. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  354. app.state.config.BANNERS = WEBUI_BANNERS
  355. app.state.config.MODEL_ORDER_LIST = MODEL_ORDER_LIST
  356. app.state.config.ENABLE_COMMUNITY_SHARING = ENABLE_COMMUNITY_SHARING
  357. app.state.config.ENABLE_MESSAGE_RATING = ENABLE_MESSAGE_RATING
  358. app.state.config.ENABLE_EVALUATION_ARENA_MODELS = ENABLE_EVALUATION_ARENA_MODELS
  359. app.state.config.EVALUATION_ARENA_MODELS = EVALUATION_ARENA_MODELS
  360. app.state.config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  361. app.state.config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  362. app.state.config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  363. app.state.config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  364. app.state.config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  365. app.state.config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  366. app.state.config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  367. app.state.config.ENABLE_LDAP = ENABLE_LDAP
  368. app.state.config.LDAP_SERVER_LABEL = LDAP_SERVER_LABEL
  369. app.state.config.LDAP_SERVER_HOST = LDAP_SERVER_HOST
  370. app.state.config.LDAP_SERVER_PORT = LDAP_SERVER_PORT
  371. app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = LDAP_ATTRIBUTE_FOR_USERNAME
  372. app.state.config.LDAP_APP_DN = LDAP_APP_DN
  373. app.state.config.LDAP_APP_PASSWORD = LDAP_APP_PASSWORD
  374. app.state.config.LDAP_SEARCH_BASE = LDAP_SEARCH_BASE
  375. app.state.config.LDAP_SEARCH_FILTERS = LDAP_SEARCH_FILTERS
  376. app.state.config.LDAP_USE_TLS = LDAP_USE_TLS
  377. app.state.config.LDAP_CA_CERT_FILE = LDAP_CA_CERT_FILE
  378. app.state.config.LDAP_CIPHERS = LDAP_CIPHERS
  379. app.state.AUTH_TRUSTED_EMAIL_HEADER = WEBUI_AUTH_TRUSTED_EMAIL_HEADER
  380. app.state.AUTH_TRUSTED_NAME_HEADER = WEBUI_AUTH_TRUSTED_NAME_HEADER
  381. app.state.TOOLS = {}
  382. app.state.FUNCTIONS = {}
  383. ########################################
  384. #
  385. # RETRIEVAL
  386. #
  387. ########################################
  388. app.state.config.TOP_K = RAG_TOP_K
  389. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  390. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  391. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  392. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  393. app.state.config.ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION = (
  394. ENABLE_RAG_WEB_LOADER_SSL_VERIFICATION
  395. )
  396. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  397. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  398. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  399. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  400. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  401. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  402. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  403. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  404. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  405. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  406. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  407. app.state.config.RAG_OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  408. app.state.config.RAG_OPENAI_API_KEY = RAG_OPENAI_API_KEY
  409. app.state.config.RAG_OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  410. app.state.config.RAG_OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  411. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  412. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  413. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  414. app.state.config.ENABLE_RAG_WEB_SEARCH = ENABLE_RAG_WEB_SEARCH
  415. app.state.config.RAG_WEB_SEARCH_ENGINE = RAG_WEB_SEARCH_ENGINE
  416. app.state.config.RAG_WEB_SEARCH_DOMAIN_FILTER_LIST = RAG_WEB_SEARCH_DOMAIN_FILTER_LIST
  417. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  418. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  419. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  420. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  421. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  422. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  423. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  424. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  425. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  426. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  427. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  428. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  429. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  430. app.state.config.JINA_API_KEY = JINA_API_KEY
  431. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  432. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  433. app.state.config.RAG_WEB_SEARCH_RESULT_COUNT = RAG_WEB_SEARCH_RESULT_COUNT
  434. app.state.config.RAG_WEB_SEARCH_CONCURRENT_REQUESTS = RAG_WEB_SEARCH_CONCURRENT_REQUESTS
  435. app.state.EMBEDDING_FUNCTION = None
  436. app.state.ef = None
  437. app.state.rf = None
  438. app.state.YOUTUBE_LOADER_TRANSLATION = None
  439. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  440. app.state.config.RAG_EMBEDDING_ENGINE,
  441. app.state.config.RAG_EMBEDDING_MODEL,
  442. app.state.ef,
  443. (
  444. app.state.config.RAG_OPENAI_API_BASE_URL
  445. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  446. else app.state.config.RAG_OLLAMA_BASE_URL
  447. ),
  448. (
  449. app.state.config.RAG_OPENAI_API_KEY
  450. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  451. else app.state.config.RAG_OLLAMA_API_KEY
  452. ),
  453. app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  454. )
  455. try:
  456. app.state.ef = get_ef(
  457. app.state.config.RAG_EMBEDDING_ENGINE,
  458. app.state.config.RAG_EMBEDDING_MODEL,
  459. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  460. )
  461. app.state.rf = get_rf(
  462. app.state.config.RAG_RERANKING_MODEL,
  463. RAG_RERANKING_MODEL_AUTO_UPDATE,
  464. )
  465. except Exception as e:
  466. log.error(f"Error updating models: {e}")
  467. pass
  468. ########################################
  469. #
  470. # IMAGES
  471. #
  472. ########################################
  473. app.state.config.IMAGE_GENERATION_ENGINE = IMAGE_GENERATION_ENGINE
  474. app.state.config.ENABLE_IMAGE_GENERATION = ENABLE_IMAGE_GENERATION
  475. app.state.config.IMAGES_OPENAI_API_BASE_URL = IMAGES_OPENAI_API_BASE_URL
  476. app.state.config.IMAGES_OPENAI_API_KEY = IMAGES_OPENAI_API_KEY
  477. app.state.config.IMAGE_GENERATION_MODEL = IMAGE_GENERATION_MODEL
  478. app.state.config.AUTOMATIC1111_BASE_URL = AUTOMATIC1111_BASE_URL
  479. app.state.config.AUTOMATIC1111_API_AUTH = AUTOMATIC1111_API_AUTH
  480. app.state.config.AUTOMATIC1111_CFG_SCALE = AUTOMATIC1111_CFG_SCALE
  481. app.state.config.AUTOMATIC1111_SAMPLER = AUTOMATIC1111_SAMPLER
  482. app.state.config.AUTOMATIC1111_SCHEDULER = AUTOMATIC1111_SCHEDULER
  483. app.state.config.COMFYUI_BASE_URL = COMFYUI_BASE_URL
  484. app.state.config.COMFYUI_API_KEY = COMFYUI_API_KEY
  485. app.state.config.COMFYUI_WORKFLOW = COMFYUI_WORKFLOW
  486. app.state.config.COMFYUI_WORKFLOW_NODES = COMFYUI_WORKFLOW_NODES
  487. app.state.config.IMAGE_SIZE = IMAGE_SIZE
  488. app.state.config.IMAGE_STEPS = IMAGE_STEPS
  489. ########################################
  490. #
  491. # AUDIO
  492. #
  493. ########################################
  494. app.state.config.STT_OPENAI_API_BASE_URL = AUDIO_STT_OPENAI_API_BASE_URL
  495. app.state.config.STT_OPENAI_API_KEY = AUDIO_STT_OPENAI_API_KEY
  496. app.state.config.STT_ENGINE = AUDIO_STT_ENGINE
  497. app.state.config.STT_MODEL = AUDIO_STT_MODEL
  498. app.state.config.WHISPER_MODEL = WHISPER_MODEL
  499. app.state.config.TTS_OPENAI_API_BASE_URL = AUDIO_TTS_OPENAI_API_BASE_URL
  500. app.state.config.TTS_OPENAI_API_KEY = AUDIO_TTS_OPENAI_API_KEY
  501. app.state.config.TTS_ENGINE = AUDIO_TTS_ENGINE
  502. app.state.config.TTS_MODEL = AUDIO_TTS_MODEL
  503. app.state.config.TTS_VOICE = AUDIO_TTS_VOICE
  504. app.state.config.TTS_API_KEY = AUDIO_TTS_API_KEY
  505. app.state.config.TTS_SPLIT_ON = AUDIO_TTS_SPLIT_ON
  506. app.state.config.TTS_AZURE_SPEECH_REGION = AUDIO_TTS_AZURE_SPEECH_REGION
  507. app.state.config.TTS_AZURE_SPEECH_OUTPUT_FORMAT = AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
  508. app.state.faster_whisper_model = None
  509. app.state.speech_synthesiser = None
  510. app.state.speech_speaker_embeddings_dataset = None
  511. ########################################
  512. #
  513. # TASKS
  514. #
  515. ########################################
  516. app.state.config.TASK_MODEL = TASK_MODEL
  517. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  518. app.state.config.ENABLE_SEARCH_QUERY_GENERATION = ENABLE_SEARCH_QUERY_GENERATION
  519. app.state.config.ENABLE_RETRIEVAL_QUERY_GENERATION = ENABLE_RETRIEVAL_QUERY_GENERATION
  520. app.state.config.ENABLE_AUTOCOMPLETE_GENERATION = ENABLE_AUTOCOMPLETE_GENERATION
  521. app.state.config.ENABLE_TAGS_GENERATION = ENABLE_TAGS_GENERATION
  522. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  523. app.state.config.TAGS_GENERATION_PROMPT_TEMPLATE = TAGS_GENERATION_PROMPT_TEMPLATE
  524. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  525. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  526. )
  527. app.state.config.QUERY_GENERATION_PROMPT_TEMPLATE = QUERY_GENERATION_PROMPT_TEMPLATE
  528. app.state.config.AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = (
  529. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
  530. )
  531. app.state.config.AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = (
  532. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
  533. )
  534. ########################################
  535. #
  536. # WEBUI
  537. #
  538. ########################################
  539. app.state.MODELS = {}
  540. class RedirectMiddleware(BaseHTTPMiddleware):
  541. async def dispatch(self, request: Request, call_next):
  542. # Check if the request is a GET request
  543. if request.method == "GET":
  544. path = request.url.path
  545. query_params = dict(parse_qs(urlparse(str(request.url)).query))
  546. # Check for the specific watch path and the presence of 'v' parameter
  547. if path.endswith("/watch") and "v" in query_params:
  548. video_id = query_params["v"][0] # Extract the first 'v' parameter
  549. encoded_video_id = urlencode({"youtube": video_id})
  550. redirect_url = f"/?{encoded_video_id}"
  551. return RedirectResponse(url=redirect_url)
  552. # Proceed with the normal flow of other requests
  553. response = await call_next(request)
  554. return response
  555. # Add the middleware to the app
  556. app.add_middleware(RedirectMiddleware)
  557. app.add_middleware(SecurityHeadersMiddleware)
  558. @app.middleware("http")
  559. async def commit_session_after_request(request: Request, call_next):
  560. response = await call_next(request)
  561. # log.debug("Commit session after request")
  562. Session.commit()
  563. return response
  564. @app.middleware("http")
  565. async def check_url(request: Request, call_next):
  566. start_time = int(time.time())
  567. request.state.enable_api_key = app.state.config.ENABLE_API_KEY
  568. response = await call_next(request)
  569. process_time = int(time.time()) - start_time
  570. response.headers["X-Process-Time"] = str(process_time)
  571. return response
  572. @app.middleware("http")
  573. async def inspect_websocket(request: Request, call_next):
  574. if (
  575. "/ws/socket.io" in request.url.path
  576. and request.query_params.get("transport") == "websocket"
  577. ):
  578. upgrade = (request.headers.get("Upgrade") or "").lower()
  579. connection = (request.headers.get("Connection") or "").lower().split(",")
  580. # Check that there's the correct headers for an upgrade, else reject the connection
  581. # This is to work around this upstream issue: https://github.com/miguelgrinberg/python-engineio/issues/367
  582. if upgrade != "websocket" or "upgrade" not in connection:
  583. return JSONResponse(
  584. status_code=status.HTTP_400_BAD_REQUEST,
  585. content={"detail": "Invalid WebSocket upgrade request"},
  586. )
  587. return await call_next(request)
  588. app.add_middleware(
  589. CORSMiddleware,
  590. allow_origins=CORS_ALLOW_ORIGIN,
  591. allow_credentials=True,
  592. allow_methods=["*"],
  593. allow_headers=["*"],
  594. )
  595. app.mount("/ws", socket_app)
  596. app.include_router(ollama.router, prefix="/ollama", tags=["ollama"])
  597. app.include_router(openai.router, prefix="/openai", tags=["openai"])
  598. app.include_router(pipelines.router, prefix="/api/v1/pipelines", tags=["pipelines"])
  599. app.include_router(tasks.router, prefix="/api/v1/tasks", tags=["tasks"])
  600. app.include_router(images.router, prefix="/api/v1/images", tags=["images"])
  601. app.include_router(audio.router, prefix="/api/v1/audio", tags=["audio"])
  602. app.include_router(retrieval.router, prefix="/api/v1/retrieval", tags=["retrieval"])
  603. app.include_router(configs.router, prefix="/api/v1/configs", tags=["configs"])
  604. app.include_router(auths.router, prefix="/api/v1/auths", tags=["auths"])
  605. app.include_router(users.router, prefix="/api/v1/users", tags=["users"])
  606. app.include_router(chats.router, prefix="/api/v1/chats", tags=["chats"])
  607. app.include_router(models.router, prefix="/api/v1/models", tags=["models"])
  608. app.include_router(knowledge.router, prefix="/api/v1/knowledge", tags=["knowledge"])
  609. app.include_router(prompts.router, prefix="/api/v1/prompts", tags=["prompts"])
  610. app.include_router(tools.router, prefix="/api/v1/tools", tags=["tools"])
  611. app.include_router(memories.router, prefix="/api/v1/memories", tags=["memories"])
  612. app.include_router(folders.router, prefix="/api/v1/folders", tags=["folders"])
  613. app.include_router(groups.router, prefix="/api/v1/groups", tags=["groups"])
  614. app.include_router(files.router, prefix="/api/v1/files", tags=["files"])
  615. app.include_router(functions.router, prefix="/api/v1/functions", tags=["functions"])
  616. app.include_router(
  617. evaluations.router, prefix="/api/v1/evaluations", tags=["evaluations"]
  618. )
  619. app.include_router(utils.router, prefix="/api/v1/utils", tags=["utils"])
  620. ##################################
  621. #
  622. # Chat Endpoints
  623. #
  624. ##################################
  625. @app.get("/api/models")
  626. async def get_models(request: Request, user=Depends(get_verified_user)):
  627. def get_filtered_models(models, user):
  628. filtered_models = []
  629. for model in models:
  630. if model.get("arena"):
  631. if has_access(
  632. user.id,
  633. type="read",
  634. access_control=model.get("info", {})
  635. .get("meta", {})
  636. .get("access_control", {}),
  637. ):
  638. filtered_models.append(model)
  639. continue
  640. model_info = Models.get_model_by_id(model["id"])
  641. if model_info:
  642. if user.id == model_info.user_id or has_access(
  643. user.id, type="read", access_control=model_info.access_control
  644. ):
  645. filtered_models.append(model)
  646. return filtered_models
  647. models = await get_all_models(request)
  648. # Filter out filter pipelines
  649. models = [
  650. model
  651. for model in models
  652. if "pipeline" not in model or model["pipeline"].get("type", None) != "filter"
  653. ]
  654. model_order_list = request.app.state.config.MODEL_ORDER_LIST
  655. if model_order_list:
  656. model_order_dict = {model_id: i for i, model_id in enumerate(model_order_list)}
  657. # Sort models by order list priority, with fallback for those not in the list
  658. models.sort(
  659. key=lambda x: (model_order_dict.get(x["id"], float("inf")), x["name"])
  660. )
  661. # Filter out models that the user does not have access to
  662. if user.role == "user" and not BYPASS_MODEL_ACCESS_CONTROL:
  663. models = get_filtered_models(models, user)
  664. log.debug(
  665. f"/api/models returned filtered models accessible to the user: {json.dumps([model['id'] for model in models])}"
  666. )
  667. return {"data": models}
  668. @app.get("/api/models/base")
  669. async def get_base_models(request: Request, user=Depends(get_admin_user)):
  670. models = await get_all_base_models(request)
  671. return {"data": models}
  672. @app.post("/api/chat/completions")
  673. async def chat_completion(
  674. request: Request,
  675. form_data: dict,
  676. user=Depends(get_verified_user),
  677. bypass_filter: bool = False,
  678. ):
  679. if not request.app.state.MODELS:
  680. await get_all_models(request)
  681. try:
  682. model_id = form_data.get("model", None)
  683. if model_id not in request.app.state.MODELS:
  684. raise Exception("Model not found")
  685. model = request.app.state.MODELS[model_id]
  686. # Check if user has access to the model
  687. if not bypass_filter and user.role == "user":
  688. try:
  689. check_model_access(user, model)
  690. except Exception as e:
  691. raise e
  692. form_data, events = await process_chat_payload(request, form_data, user, model)
  693. except Exception as e:
  694. raise HTTPException(
  695. status_code=status.HTTP_400_BAD_REQUEST,
  696. detail=str(e),
  697. )
  698. try:
  699. response = await chat_completion_handler(
  700. request, form_data, user, bypass_filter
  701. )
  702. return await process_chat_response(response, events)
  703. except Exception as e:
  704. raise HTTPException(
  705. status_code=status.HTTP_400_BAD_REQUEST,
  706. detail=str(e),
  707. )
  708. # Alias for chat_completion (Legacy)
  709. generate_chat_completions = chat_completion
  710. generate_chat_completion = chat_completion
  711. @app.post("/api/chat/completed")
  712. async def chat_completed(
  713. request: Request, form_data: dict, user=Depends(get_verified_user)
  714. ):
  715. try:
  716. return await chat_completed_handler(request, form_data, user)
  717. except Exception as e:
  718. raise HTTPException(
  719. status_code=status.HTTP_400_BAD_REQUEST,
  720. detail=str(e),
  721. )
  722. @app.post("/api/chat/actions/{action_id}")
  723. async def chat_action(
  724. request: Request, action_id: str, form_data: dict, user=Depends(get_verified_user)
  725. ):
  726. try:
  727. return await chat_action_handler(request, action_id, form_data, user)
  728. except Exception as e:
  729. raise HTTPException(
  730. status_code=status.HTTP_400_BAD_REQUEST,
  731. detail=str(e),
  732. )
  733. ##################################
  734. #
  735. # Config Endpoints
  736. #
  737. ##################################
  738. @app.get("/api/config")
  739. async def get_app_config(request: Request):
  740. user = None
  741. if "token" in request.cookies:
  742. token = request.cookies.get("token")
  743. try:
  744. data = decode_token(token)
  745. except Exception as e:
  746. log.debug(e)
  747. raise HTTPException(
  748. status_code=status.HTTP_401_UNAUTHORIZED,
  749. detail="Invalid token",
  750. )
  751. if data is not None and "id" in data:
  752. user = Users.get_user_by_id(data["id"])
  753. onboarding = False
  754. if user is None:
  755. user_count = Users.get_num_users()
  756. onboarding = user_count == 0
  757. return {
  758. **({"onboarding": True} if onboarding else {}),
  759. "status": True,
  760. "name": WEBUI_NAME,
  761. "version": VERSION,
  762. "default_locale": str(DEFAULT_LOCALE),
  763. "oauth": {
  764. "providers": {
  765. name: config.get("name", name)
  766. for name, config in OAUTH_PROVIDERS.items()
  767. }
  768. },
  769. "features": {
  770. "auth": WEBUI_AUTH,
  771. "auth_trusted_header": bool(app.state.AUTH_TRUSTED_EMAIL_HEADER),
  772. "enable_ldap": app.state.config.ENABLE_LDAP,
  773. "enable_api_key": app.state.config.ENABLE_API_KEY,
  774. "enable_signup": app.state.config.ENABLE_SIGNUP,
  775. "enable_login_form": app.state.config.ENABLE_LOGIN_FORM,
  776. **(
  777. {
  778. "enable_web_search": app.state.config.ENABLE_RAG_WEB_SEARCH,
  779. "enable_image_generation": app.state.config.ENABLE_IMAGE_GENERATION,
  780. "enable_community_sharing": app.state.config.ENABLE_COMMUNITY_SHARING,
  781. "enable_message_rating": app.state.config.ENABLE_MESSAGE_RATING,
  782. "enable_admin_export": ENABLE_ADMIN_EXPORT,
  783. "enable_admin_chat_access": ENABLE_ADMIN_CHAT_ACCESS,
  784. }
  785. if user is not None
  786. else {}
  787. ),
  788. },
  789. **(
  790. {
  791. "default_models": app.state.config.DEFAULT_MODELS,
  792. "default_prompt_suggestions": app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
  793. "audio": {
  794. "tts": {
  795. "engine": app.state.config.TTS_ENGINE,
  796. "voice": app.state.config.TTS_VOICE,
  797. "split_on": app.state.config.TTS_SPLIT_ON,
  798. },
  799. "stt": {
  800. "engine": app.state.config.STT_ENGINE,
  801. },
  802. },
  803. "file": {
  804. "max_size": app.state.config.FILE_MAX_SIZE,
  805. "max_count": app.state.config.FILE_MAX_COUNT,
  806. },
  807. "permissions": {**app.state.config.USER_PERMISSIONS},
  808. }
  809. if user is not None
  810. else {}
  811. ),
  812. }
  813. class UrlForm(BaseModel):
  814. url: str
  815. @app.get("/api/webhook")
  816. async def get_webhook_url(user=Depends(get_admin_user)):
  817. return {
  818. "url": app.state.config.WEBHOOK_URL,
  819. }
  820. @app.post("/api/webhook")
  821. async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
  822. app.state.config.WEBHOOK_URL = form_data.url
  823. app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
  824. return {"url": app.state.config.WEBHOOK_URL}
  825. @app.get("/api/version")
  826. async def get_app_version():
  827. return {
  828. "version": VERSION,
  829. }
  830. @app.get("/api/version/updates")
  831. async def get_app_latest_release_version():
  832. if OFFLINE_MODE:
  833. log.debug(
  834. f"Offline mode is enabled, returning current version as latest version"
  835. )
  836. return {"current": VERSION, "latest": VERSION}
  837. try:
  838. timeout = aiohttp.ClientTimeout(total=1)
  839. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  840. async with session.get(
  841. "https://api.github.com/repos/open-webui/open-webui/releases/latest"
  842. ) as response:
  843. response.raise_for_status()
  844. data = await response.json()
  845. latest_version = data["tag_name"]
  846. return {"current": VERSION, "latest": latest_version[1:]}
  847. except Exception as e:
  848. log.debug(e)
  849. return {"current": VERSION, "latest": VERSION}
  850. @app.get("/api/changelog")
  851. async def get_app_changelog():
  852. return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
  853. ############################
  854. # OAuth Login & Callback
  855. ############################
  856. # SessionMiddleware is used by authlib for oauth
  857. if len(OAUTH_PROVIDERS) > 0:
  858. app.add_middleware(
  859. SessionMiddleware,
  860. secret_key=WEBUI_SECRET_KEY,
  861. session_cookie="oui-session",
  862. same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  863. https_only=WEBUI_SESSION_COOKIE_SECURE,
  864. )
  865. @app.get("/oauth/{provider}/login")
  866. async def oauth_login(provider: str, request: Request):
  867. return await oauth_manager.handle_login(provider, request)
  868. # OAuth login logic is as follows:
  869. # 1. Attempt to find a user with matching subject ID, tied to the provider
  870. # 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
  871. # - This is considered insecure in general, as OAuth providers do not always verify email addresses
  872. # 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
  873. # - Email addresses are considered unique, so we fail registration if the email address is already taken
  874. @app.get("/oauth/{provider}/callback")
  875. async def oauth_callback(provider: str, request: Request, response: Response):
  876. return await oauth_manager.handle_callback(provider, request, response)
  877. @app.get("/manifest.json")
  878. async def get_manifest_json():
  879. return {
  880. "name": WEBUI_NAME,
  881. "short_name": WEBUI_NAME,
  882. "description": "Open WebUI is an open, extensible, user-friendly interface for AI that adapts to your workflow.",
  883. "start_url": "/",
  884. "display": "standalone",
  885. "background_color": "#343541",
  886. "orientation": "natural",
  887. "icons": [
  888. {
  889. "src": "/static/logo.png",
  890. "type": "image/png",
  891. "sizes": "500x500",
  892. "purpose": "any",
  893. },
  894. {
  895. "src": "/static/logo.png",
  896. "type": "image/png",
  897. "sizes": "500x500",
  898. "purpose": "maskable",
  899. },
  900. ],
  901. }
  902. @app.get("/opensearch.xml")
  903. async def get_opensearch_xml():
  904. xml_content = rf"""
  905. <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  906. <ShortName>{WEBUI_NAME}</ShortName>
  907. <Description>Search {WEBUI_NAME}</Description>
  908. <InputEncoding>UTF-8</InputEncoding>
  909. <Image width="16" height="16" type="image/x-icon">{WEBUI_URL}/static/favicon.png</Image>
  910. <Url type="text/html" method="get" template="{WEBUI_URL}/?q={"{searchTerms}"}"/>
  911. <moz:SearchForm>{WEBUI_URL}</moz:SearchForm>
  912. </OpenSearchDescription>
  913. """
  914. return Response(content=xml_content, media_type="application/xml")
  915. @app.get("/health")
  916. async def healthcheck():
  917. return {"status": True}
  918. @app.get("/health/db")
  919. async def healthcheck_with_db():
  920. Session.execute(text("SELECT 1;")).all()
  921. return {"status": True}
  922. app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
  923. app.mount("/cache", StaticFiles(directory=CACHE_DIR), name="cache")
  924. def swagger_ui_html(*args, **kwargs):
  925. return get_swagger_ui_html(
  926. *args,
  927. **kwargs,
  928. swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
  929. swagger_css_url="/static/swagger-ui/swagger-ui.css",
  930. swagger_favicon_url="/static/swagger-ui/favicon.png",
  931. )
  932. applications.get_swagger_ui_html = swagger_ui_html
  933. if os.path.exists(FRONTEND_BUILD_DIR):
  934. mimetypes.add_type("text/javascript", ".js")
  935. app.mount(
  936. "/",
  937. SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
  938. name="spa-static-files",
  939. )
  940. else:
  941. log.warning(
  942. f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
  943. )