main.py 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034
  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 uuid import uuid4
  12. from contextlib import asynccontextmanager
  13. from urllib.parse import urlencode, parse_qs, urlparse
  14. from pydantic import BaseModel
  15. from sqlalchemy import text
  16. from typing import Optional
  17. from aiocache import cached
  18. import aiohttp
  19. import anyio.to_thread
  20. import requests
  21. from redis import Redis
  22. from fastapi import (
  23. Depends,
  24. FastAPI,
  25. File,
  26. Form,
  27. HTTPException,
  28. Request,
  29. UploadFile,
  30. status,
  31. applications,
  32. BackgroundTasks,
  33. )
  34. from fastapi.openapi.docs import get_swagger_ui_html
  35. from fastapi.middleware.cors import CORSMiddleware
  36. from fastapi.responses import FileResponse, JSONResponse, RedirectResponse
  37. from fastapi.staticfiles import StaticFiles
  38. from starlette_compress import CompressMiddleware
  39. from starlette.exceptions import HTTPException as StarletteHTTPException
  40. from starlette.middleware.base import BaseHTTPMiddleware
  41. from starlette.middleware.sessions import SessionMiddleware
  42. from starlette.responses import Response, StreamingResponse
  43. from starlette.datastructures import Headers
  44. from starsessions import (
  45. SessionMiddleware as StarSessionsMiddleware,
  46. SessionAutoloadMiddleware,
  47. )
  48. from starsessions.stores.redis import RedisStore
  49. from open_webui.utils import logger
  50. from open_webui.utils.audit import AuditLevel, AuditLoggingMiddleware
  51. from open_webui.utils.logger import start_logger
  52. from open_webui.socket.main import (
  53. app as socket_app,
  54. periodic_usage_pool_cleanup,
  55. get_event_emitter,
  56. get_models_in_use,
  57. get_active_user_ids,
  58. )
  59. from open_webui.routers import (
  60. audio,
  61. images,
  62. ollama,
  63. openai,
  64. retrieval,
  65. pipelines,
  66. tasks,
  67. auths,
  68. channels,
  69. chats,
  70. notes,
  71. folders,
  72. configs,
  73. groups,
  74. files,
  75. functions,
  76. memories,
  77. models,
  78. knowledge,
  79. prompts,
  80. evaluations,
  81. tools,
  82. users,
  83. utils,
  84. scim,
  85. )
  86. from open_webui.routers.retrieval import (
  87. get_embedding_function,
  88. get_reranking_function,
  89. get_ef,
  90. get_rf,
  91. )
  92. from open_webui.internal.db import Session, engine
  93. from open_webui.models.functions import Functions
  94. from open_webui.models.models import Models
  95. from open_webui.models.users import UserModel, Users
  96. from open_webui.models.chats import Chats
  97. from open_webui.config import (
  98. # Ollama
  99. ENABLE_OLLAMA_API,
  100. OLLAMA_BASE_URLS,
  101. OLLAMA_API_CONFIGS,
  102. # OpenAI
  103. ENABLE_OPENAI_API,
  104. OPENAI_API_BASE_URLS,
  105. OPENAI_API_KEYS,
  106. OPENAI_API_CONFIGS,
  107. # Direct Connections
  108. ENABLE_DIRECT_CONNECTIONS,
  109. # Model list
  110. ENABLE_BASE_MODELS_CACHE,
  111. # Thread pool size for FastAPI/AnyIO
  112. THREAD_POOL_SIZE,
  113. # Tool Server Configs
  114. TOOL_SERVER_CONNECTIONS,
  115. # Code Execution
  116. ENABLE_CODE_EXECUTION,
  117. CODE_EXECUTION_ENGINE,
  118. CODE_EXECUTION_JUPYTER_URL,
  119. CODE_EXECUTION_JUPYTER_AUTH,
  120. CODE_EXECUTION_JUPYTER_AUTH_TOKEN,
  121. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD,
  122. CODE_EXECUTION_JUPYTER_TIMEOUT,
  123. ENABLE_CODE_INTERPRETER,
  124. CODE_INTERPRETER_ENGINE,
  125. CODE_INTERPRETER_PROMPT_TEMPLATE,
  126. CODE_INTERPRETER_JUPYTER_URL,
  127. CODE_INTERPRETER_JUPYTER_AUTH,
  128. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN,
  129. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD,
  130. CODE_INTERPRETER_JUPYTER_TIMEOUT,
  131. # Image
  132. AUTOMATIC1111_API_AUTH,
  133. AUTOMATIC1111_BASE_URL,
  134. AUTOMATIC1111_CFG_SCALE,
  135. AUTOMATIC1111_SAMPLER,
  136. AUTOMATIC1111_SCHEDULER,
  137. COMFYUI_BASE_URL,
  138. COMFYUI_API_KEY,
  139. COMFYUI_WORKFLOW,
  140. COMFYUI_WORKFLOW_NODES,
  141. ENABLE_IMAGE_GENERATION,
  142. ENABLE_IMAGE_PROMPT_GENERATION,
  143. IMAGE_GENERATION_ENGINE,
  144. IMAGE_GENERATION_MODEL,
  145. IMAGE_SIZE,
  146. IMAGE_STEPS,
  147. IMAGES_OPENAI_API_BASE_URL,
  148. IMAGES_OPENAI_API_VERSION,
  149. IMAGES_OPENAI_API_KEY,
  150. IMAGES_GEMINI_API_BASE_URL,
  151. IMAGES_GEMINI_API_KEY,
  152. # Audio
  153. AUDIO_STT_ENGINE,
  154. AUDIO_STT_MODEL,
  155. AUDIO_STT_SUPPORTED_CONTENT_TYPES,
  156. AUDIO_STT_OPENAI_API_BASE_URL,
  157. AUDIO_STT_OPENAI_API_KEY,
  158. AUDIO_STT_AZURE_API_KEY,
  159. AUDIO_STT_AZURE_REGION,
  160. AUDIO_STT_AZURE_LOCALES,
  161. AUDIO_STT_AZURE_BASE_URL,
  162. AUDIO_STT_AZURE_MAX_SPEAKERS,
  163. AUDIO_TTS_API_KEY,
  164. AUDIO_TTS_ENGINE,
  165. AUDIO_TTS_MODEL,
  166. AUDIO_TTS_OPENAI_API_BASE_URL,
  167. AUDIO_TTS_OPENAI_API_KEY,
  168. AUDIO_TTS_SPLIT_ON,
  169. AUDIO_TTS_VOICE,
  170. AUDIO_TTS_AZURE_SPEECH_REGION,
  171. AUDIO_TTS_AZURE_SPEECH_BASE_URL,
  172. AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT,
  173. PLAYWRIGHT_WS_URL,
  174. PLAYWRIGHT_TIMEOUT,
  175. FIRECRAWL_API_BASE_URL,
  176. FIRECRAWL_API_KEY,
  177. WEB_LOADER_ENGINE,
  178. WEB_LOADER_CONCURRENT_REQUESTS,
  179. WHISPER_MODEL,
  180. WHISPER_VAD_FILTER,
  181. WHISPER_LANGUAGE,
  182. DEEPGRAM_API_KEY,
  183. WHISPER_MODEL_AUTO_UPDATE,
  184. WHISPER_MODEL_DIR,
  185. # Retrieval
  186. RAG_TEMPLATE,
  187. DEFAULT_RAG_TEMPLATE,
  188. RAG_FULL_CONTEXT,
  189. BYPASS_EMBEDDING_AND_RETRIEVAL,
  190. RAG_EMBEDDING_MODEL,
  191. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  192. RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE,
  193. RAG_RERANKING_ENGINE,
  194. RAG_RERANKING_MODEL,
  195. RAG_EXTERNAL_RERANKER_URL,
  196. RAG_EXTERNAL_RERANKER_API_KEY,
  197. RAG_RERANKING_MODEL_AUTO_UPDATE,
  198. RAG_RERANKING_MODEL_TRUST_REMOTE_CODE,
  199. RAG_EMBEDDING_ENGINE,
  200. RAG_EMBEDDING_BATCH_SIZE,
  201. RAG_TOP_K,
  202. RAG_TOP_K_RERANKER,
  203. RAG_RELEVANCE_THRESHOLD,
  204. RAG_HYBRID_BM25_WEIGHT,
  205. RAG_ALLOWED_FILE_EXTENSIONS,
  206. RAG_FILE_MAX_COUNT,
  207. RAG_FILE_MAX_SIZE,
  208. FILE_IMAGE_COMPRESSION_WIDTH,
  209. FILE_IMAGE_COMPRESSION_HEIGHT,
  210. RAG_OPENAI_API_BASE_URL,
  211. RAG_OPENAI_API_KEY,
  212. RAG_AZURE_OPENAI_BASE_URL,
  213. RAG_AZURE_OPENAI_API_KEY,
  214. RAG_AZURE_OPENAI_API_VERSION,
  215. RAG_OLLAMA_BASE_URL,
  216. RAG_OLLAMA_API_KEY,
  217. CHUNK_OVERLAP,
  218. CHUNK_SIZE,
  219. CONTENT_EXTRACTION_ENGINE,
  220. DATALAB_MARKER_API_KEY,
  221. DATALAB_MARKER_API_BASE_URL,
  222. DATALAB_MARKER_ADDITIONAL_CONFIG,
  223. DATALAB_MARKER_SKIP_CACHE,
  224. DATALAB_MARKER_FORCE_OCR,
  225. DATALAB_MARKER_PAGINATE,
  226. DATALAB_MARKER_STRIP_EXISTING_OCR,
  227. DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION,
  228. DATALAB_MARKER_FORMAT_LINES,
  229. DATALAB_MARKER_OUTPUT_FORMAT,
  230. DATALAB_MARKER_USE_LLM,
  231. EXTERNAL_DOCUMENT_LOADER_URL,
  232. EXTERNAL_DOCUMENT_LOADER_API_KEY,
  233. TIKA_SERVER_URL,
  234. DOCLING_SERVER_URL,
  235. DOCLING_DO_OCR,
  236. DOCLING_FORCE_OCR,
  237. DOCLING_OCR_ENGINE,
  238. DOCLING_OCR_LANG,
  239. DOCLING_PDF_BACKEND,
  240. DOCLING_TABLE_MODE,
  241. DOCLING_PIPELINE,
  242. DOCLING_DO_PICTURE_DESCRIPTION,
  243. DOCLING_PICTURE_DESCRIPTION_MODE,
  244. DOCLING_PICTURE_DESCRIPTION_LOCAL,
  245. DOCLING_PICTURE_DESCRIPTION_API,
  246. DOCUMENT_INTELLIGENCE_ENDPOINT,
  247. DOCUMENT_INTELLIGENCE_KEY,
  248. MISTRAL_OCR_API_KEY,
  249. RAG_TEXT_SPLITTER,
  250. TIKTOKEN_ENCODING_NAME,
  251. PDF_EXTRACT_IMAGES,
  252. YOUTUBE_LOADER_LANGUAGE,
  253. YOUTUBE_LOADER_PROXY_URL,
  254. # Retrieval (Web Search)
  255. ENABLE_WEB_SEARCH,
  256. WEB_SEARCH_ENGINE,
  257. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL,
  258. BYPASS_WEB_SEARCH_WEB_LOADER,
  259. WEB_SEARCH_RESULT_COUNT,
  260. WEB_SEARCH_CONCURRENT_REQUESTS,
  261. WEB_SEARCH_TRUST_ENV,
  262. WEB_SEARCH_DOMAIN_FILTER_LIST,
  263. OLLAMA_CLOUD_WEB_SEARCH_API_KEY,
  264. JINA_API_KEY,
  265. SEARCHAPI_API_KEY,
  266. SEARCHAPI_ENGINE,
  267. SERPAPI_API_KEY,
  268. SERPAPI_ENGINE,
  269. SEARXNG_QUERY_URL,
  270. YACY_QUERY_URL,
  271. YACY_USERNAME,
  272. YACY_PASSWORD,
  273. SERPER_API_KEY,
  274. SERPLY_API_KEY,
  275. SERPSTACK_API_KEY,
  276. SERPSTACK_HTTPS,
  277. TAVILY_API_KEY,
  278. TAVILY_EXTRACT_DEPTH,
  279. BING_SEARCH_V7_ENDPOINT,
  280. BING_SEARCH_V7_SUBSCRIPTION_KEY,
  281. BRAVE_SEARCH_API_KEY,
  282. EXA_API_KEY,
  283. PERPLEXITY_API_KEY,
  284. PERPLEXITY_MODEL,
  285. PERPLEXITY_SEARCH_CONTEXT_USAGE,
  286. SOUGOU_API_SID,
  287. SOUGOU_API_SK,
  288. KAGI_SEARCH_API_KEY,
  289. MOJEEK_SEARCH_API_KEY,
  290. BOCHA_SEARCH_API_KEY,
  291. GOOGLE_PSE_API_KEY,
  292. GOOGLE_PSE_ENGINE_ID,
  293. GOOGLE_DRIVE_CLIENT_ID,
  294. GOOGLE_DRIVE_API_KEY,
  295. ENABLE_ONEDRIVE_INTEGRATION,
  296. ONEDRIVE_CLIENT_ID_PERSONAL,
  297. ONEDRIVE_CLIENT_ID_BUSINESS,
  298. ONEDRIVE_SHAREPOINT_URL,
  299. ONEDRIVE_SHAREPOINT_TENANT_ID,
  300. ENABLE_ONEDRIVE_PERSONAL,
  301. ENABLE_ONEDRIVE_BUSINESS,
  302. ENABLE_RAG_HYBRID_SEARCH,
  303. ENABLE_RAG_LOCAL_WEB_FETCH,
  304. ENABLE_WEB_LOADER_SSL_VERIFICATION,
  305. ENABLE_GOOGLE_DRIVE_INTEGRATION,
  306. UPLOAD_DIR,
  307. EXTERNAL_WEB_SEARCH_URL,
  308. EXTERNAL_WEB_SEARCH_API_KEY,
  309. EXTERNAL_WEB_LOADER_URL,
  310. EXTERNAL_WEB_LOADER_API_KEY,
  311. # WebUI
  312. WEBUI_AUTH,
  313. WEBUI_NAME,
  314. WEBUI_BANNERS,
  315. WEBHOOK_URL,
  316. ADMIN_EMAIL,
  317. SHOW_ADMIN_DETAILS,
  318. JWT_EXPIRES_IN,
  319. ENABLE_SIGNUP,
  320. ENABLE_LOGIN_FORM,
  321. ENABLE_API_KEY,
  322. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS,
  323. API_KEY_ALLOWED_ENDPOINTS,
  324. ENABLE_CHANNELS,
  325. ENABLE_NOTES,
  326. ENABLE_COMMUNITY_SHARING,
  327. ENABLE_MESSAGE_RATING,
  328. ENABLE_USER_WEBHOOKS,
  329. ENABLE_EVALUATION_ARENA_MODELS,
  330. BYPASS_ADMIN_ACCESS_CONTROL,
  331. USER_PERMISSIONS,
  332. DEFAULT_USER_ROLE,
  333. PENDING_USER_OVERLAY_CONTENT,
  334. PENDING_USER_OVERLAY_TITLE,
  335. DEFAULT_PROMPT_SUGGESTIONS,
  336. DEFAULT_MODELS,
  337. DEFAULT_ARENA_MODEL,
  338. MODEL_ORDER_LIST,
  339. EVALUATION_ARENA_MODELS,
  340. # WebUI (OAuth)
  341. ENABLE_OAUTH_ROLE_MANAGEMENT,
  342. OAUTH_ROLES_CLAIM,
  343. OAUTH_EMAIL_CLAIM,
  344. OAUTH_PICTURE_CLAIM,
  345. OAUTH_USERNAME_CLAIM,
  346. OAUTH_ALLOWED_ROLES,
  347. OAUTH_ADMIN_ROLES,
  348. # WebUI (LDAP)
  349. ENABLE_LDAP,
  350. LDAP_SERVER_LABEL,
  351. LDAP_SERVER_HOST,
  352. LDAP_SERVER_PORT,
  353. LDAP_ATTRIBUTE_FOR_MAIL,
  354. LDAP_ATTRIBUTE_FOR_USERNAME,
  355. LDAP_SEARCH_FILTERS,
  356. LDAP_SEARCH_BASE,
  357. LDAP_APP_DN,
  358. LDAP_APP_PASSWORD,
  359. LDAP_USE_TLS,
  360. LDAP_CA_CERT_FILE,
  361. LDAP_VALIDATE_CERT,
  362. LDAP_CIPHERS,
  363. # LDAP Group Management
  364. ENABLE_LDAP_GROUP_MANAGEMENT,
  365. ENABLE_LDAP_GROUP_CREATION,
  366. LDAP_ATTRIBUTE_FOR_GROUPS,
  367. # Misc
  368. ENV,
  369. CACHE_DIR,
  370. STATIC_DIR,
  371. FRONTEND_BUILD_DIR,
  372. CORS_ALLOW_ORIGIN,
  373. DEFAULT_LOCALE,
  374. OAUTH_PROVIDERS,
  375. WEBUI_URL,
  376. RESPONSE_WATERMARK,
  377. # Admin
  378. ENABLE_ADMIN_CHAT_ACCESS,
  379. BYPASS_ADMIN_ACCESS_CONTROL,
  380. ENABLE_ADMIN_EXPORT,
  381. # Tasks
  382. TASK_MODEL,
  383. TASK_MODEL_EXTERNAL,
  384. ENABLE_TAGS_GENERATION,
  385. ENABLE_TITLE_GENERATION,
  386. ENABLE_FOLLOW_UP_GENERATION,
  387. ENABLE_SEARCH_QUERY_GENERATION,
  388. ENABLE_RETRIEVAL_QUERY_GENERATION,
  389. ENABLE_AUTOCOMPLETE_GENERATION,
  390. TITLE_GENERATION_PROMPT_TEMPLATE,
  391. FOLLOW_UP_GENERATION_PROMPT_TEMPLATE,
  392. TAGS_GENERATION_PROMPT_TEMPLATE,
  393. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE,
  394. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE,
  395. QUERY_GENERATION_PROMPT_TEMPLATE,
  396. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE,
  397. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH,
  398. AppConfig,
  399. reset_config,
  400. )
  401. from open_webui.env import (
  402. LICENSE_KEY,
  403. AUDIT_EXCLUDED_PATHS,
  404. AUDIT_LOG_LEVEL,
  405. CHANGELOG,
  406. REDIS_URL,
  407. REDIS_CLUSTER,
  408. REDIS_KEY_PREFIX,
  409. REDIS_SENTINEL_HOSTS,
  410. REDIS_SENTINEL_PORT,
  411. GLOBAL_LOG_LEVEL,
  412. MAX_BODY_LOG_SIZE,
  413. SAFE_MODE,
  414. SRC_LOG_LEVELS,
  415. VERSION,
  416. INSTANCE_ID,
  417. WEBUI_BUILD_HASH,
  418. WEBUI_SECRET_KEY,
  419. WEBUI_SESSION_COOKIE_SAME_SITE,
  420. WEBUI_SESSION_COOKIE_SECURE,
  421. ENABLE_SIGNUP_PASSWORD_CONFIRMATION,
  422. WEBUI_AUTH_TRUSTED_EMAIL_HEADER,
  423. WEBUI_AUTH_TRUSTED_NAME_HEADER,
  424. WEBUI_AUTH_SIGNOUT_REDIRECT_URL,
  425. # SCIM
  426. SCIM_ENABLED,
  427. SCIM_TOKEN,
  428. ENABLE_COMPRESSION_MIDDLEWARE,
  429. ENABLE_WEBSOCKET_SUPPORT,
  430. BYPASS_MODEL_ACCESS_CONTROL,
  431. RESET_CONFIG_ON_START,
  432. ENABLE_VERSION_UPDATE_CHECK,
  433. ENABLE_OTEL,
  434. EXTERNAL_PWA_MANIFEST_URL,
  435. AIOHTTP_CLIENT_SESSION_SSL,
  436. )
  437. from open_webui.utils.models import (
  438. get_all_models,
  439. get_all_base_models,
  440. check_model_access,
  441. get_filtered_models,
  442. )
  443. from open_webui.utils.chat import (
  444. generate_chat_completion as chat_completion_handler,
  445. chat_completed as chat_completed_handler,
  446. chat_action as chat_action_handler,
  447. )
  448. from open_webui.utils.embeddings import generate_embeddings
  449. from open_webui.utils.middleware import process_chat_payload, process_chat_response
  450. from open_webui.utils.access_control import has_access
  451. from open_webui.utils.auth import (
  452. get_license_data,
  453. get_http_authorization_cred,
  454. decode_token,
  455. get_admin_user,
  456. get_verified_user,
  457. )
  458. from open_webui.utils.plugin import install_tool_and_function_dependencies
  459. from open_webui.utils.oauth import OAuthManager
  460. from open_webui.utils.security_headers import SecurityHeadersMiddleware
  461. from open_webui.utils.redis import get_redis_connection
  462. from open_webui.tasks import (
  463. redis_task_command_listener,
  464. list_task_ids_by_item_id,
  465. create_task,
  466. stop_task,
  467. list_tasks,
  468. ) # Import from tasks.py
  469. from open_webui.utils.redis import get_sentinels_from_env
  470. from open_webui.constants import ERROR_MESSAGES
  471. if SAFE_MODE:
  472. print("SAFE MODE ENABLED")
  473. Functions.deactivate_all_functions()
  474. logging.basicConfig(stream=sys.stdout, level=GLOBAL_LOG_LEVEL)
  475. log = logging.getLogger(__name__)
  476. log.setLevel(SRC_LOG_LEVELS["MAIN"])
  477. class SPAStaticFiles(StaticFiles):
  478. async def get_response(self, path: str, scope):
  479. try:
  480. return await super().get_response(path, scope)
  481. except (HTTPException, StarletteHTTPException) as ex:
  482. if ex.status_code == 404:
  483. if path.endswith(".js"):
  484. # Return 404 for javascript files
  485. raise ex
  486. else:
  487. return await super().get_response("index.html", scope)
  488. else:
  489. raise ex
  490. print(
  491. rf"""
  492. ██████╗ ██████╗ ███████╗███╗ ██╗ ██╗ ██╗███████╗██████╗ ██╗ ██╗██╗
  493. ██╔═══██╗██╔══██╗██╔════╝████╗ ██║ ██║ ██║██╔════╝██╔══██╗██║ ██║██║
  494. ██║ ██║██████╔╝█████╗ ██╔██╗ ██║ ██║ █╗ ██║█████╗ ██████╔╝██║ ██║██║
  495. ██║ ██║██╔═══╝ ██╔══╝ ██║╚██╗██║ ██║███╗██║██╔══╝ ██╔══██╗██║ ██║██║
  496. ╚██████╔╝██║ ███████╗██║ ╚████║ ╚███╔███╔╝███████╗██████╔╝╚██████╔╝██║
  497. ╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═══╝ ╚══╝╚══╝ ╚══════╝╚═════╝ ╚═════╝ ╚═╝
  498. v{VERSION} - building the best AI user interface.
  499. {f"Commit: {WEBUI_BUILD_HASH}" if WEBUI_BUILD_HASH != "dev-build" else ""}
  500. https://github.com/open-webui/open-webui
  501. """
  502. )
  503. @asynccontextmanager
  504. async def lifespan(app: FastAPI):
  505. app.state.instance_id = INSTANCE_ID
  506. start_logger()
  507. if RESET_CONFIG_ON_START:
  508. reset_config()
  509. if LICENSE_KEY:
  510. get_license_data(app, LICENSE_KEY)
  511. # This should be blocking (sync) so functions are not deactivated on first /get_models calls
  512. # when the first user lands on the / route.
  513. log.info("Installing external dependencies of functions and tools...")
  514. install_tool_and_function_dependencies()
  515. app.state.redis = get_redis_connection(
  516. redis_url=REDIS_URL,
  517. redis_sentinels=get_sentinels_from_env(
  518. REDIS_SENTINEL_HOSTS, REDIS_SENTINEL_PORT
  519. ),
  520. redis_cluster=REDIS_CLUSTER,
  521. async_mode=True,
  522. )
  523. if app.state.redis is not None:
  524. app.state.redis_task_command_listener = asyncio.create_task(
  525. redis_task_command_listener(app)
  526. )
  527. if THREAD_POOL_SIZE and THREAD_POOL_SIZE > 0:
  528. limiter = anyio.to_thread.current_default_thread_limiter()
  529. limiter.total_tokens = THREAD_POOL_SIZE
  530. asyncio.create_task(periodic_usage_pool_cleanup())
  531. if app.state.config.ENABLE_BASE_MODELS_CACHE:
  532. await get_all_models(
  533. Request(
  534. # Creating a mock request object to pass to get_all_models
  535. {
  536. "type": "http",
  537. "asgi.version": "3.0",
  538. "asgi.spec_version": "2.0",
  539. "method": "GET",
  540. "path": "/internal",
  541. "query_string": b"",
  542. "headers": Headers({}).raw,
  543. "client": ("127.0.0.1", 12345),
  544. "server": ("127.0.0.1", 80),
  545. "scheme": "http",
  546. "app": app,
  547. }
  548. ),
  549. None,
  550. )
  551. yield
  552. if hasattr(app.state, "redis_task_command_listener"):
  553. app.state.redis_task_command_listener.cancel()
  554. app = FastAPI(
  555. title="Open WebUI",
  556. docs_url="/docs" if ENV == "dev" else None,
  557. openapi_url="/openapi.json" if ENV == "dev" else None,
  558. redoc_url=None,
  559. lifespan=lifespan,
  560. )
  561. oauth_manager = OAuthManager(app)
  562. app.state.oauth_manager = oauth_manager
  563. app.state.instance_id = None
  564. app.state.config = AppConfig(
  565. redis_url=REDIS_URL,
  566. redis_sentinels=get_sentinels_from_env(REDIS_SENTINEL_HOSTS, REDIS_SENTINEL_PORT),
  567. redis_cluster=REDIS_CLUSTER,
  568. redis_key_prefix=REDIS_KEY_PREFIX,
  569. )
  570. app.state.redis = None
  571. app.state.WEBUI_NAME = WEBUI_NAME
  572. app.state.LICENSE_METADATA = None
  573. ########################################
  574. #
  575. # OPENTELEMETRY
  576. #
  577. ########################################
  578. if ENABLE_OTEL:
  579. from open_webui.utils.telemetry.setup import setup as setup_opentelemetry
  580. setup_opentelemetry(app=app, db_engine=engine)
  581. ########################################
  582. #
  583. # OLLAMA
  584. #
  585. ########################################
  586. app.state.config.ENABLE_OLLAMA_API = ENABLE_OLLAMA_API
  587. app.state.config.OLLAMA_BASE_URLS = OLLAMA_BASE_URLS
  588. app.state.config.OLLAMA_API_CONFIGS = OLLAMA_API_CONFIGS
  589. app.state.OLLAMA_MODELS = {}
  590. ########################################
  591. #
  592. # OPENAI
  593. #
  594. ########################################
  595. app.state.config.ENABLE_OPENAI_API = ENABLE_OPENAI_API
  596. app.state.config.OPENAI_API_BASE_URLS = OPENAI_API_BASE_URLS
  597. app.state.config.OPENAI_API_KEYS = OPENAI_API_KEYS
  598. app.state.config.OPENAI_API_CONFIGS = OPENAI_API_CONFIGS
  599. app.state.OPENAI_MODELS = {}
  600. ########################################
  601. #
  602. # TOOL SERVERS
  603. #
  604. ########################################
  605. app.state.config.TOOL_SERVER_CONNECTIONS = TOOL_SERVER_CONNECTIONS
  606. app.state.TOOL_SERVERS = []
  607. ########################################
  608. #
  609. # DIRECT CONNECTIONS
  610. #
  611. ########################################
  612. app.state.config.ENABLE_DIRECT_CONNECTIONS = ENABLE_DIRECT_CONNECTIONS
  613. ########################################
  614. #
  615. # SCIM
  616. #
  617. ########################################
  618. app.state.SCIM_ENABLED = SCIM_ENABLED
  619. app.state.SCIM_TOKEN = SCIM_TOKEN
  620. ########################################
  621. #
  622. # MODELS
  623. #
  624. ########################################
  625. app.state.config.ENABLE_BASE_MODELS_CACHE = ENABLE_BASE_MODELS_CACHE
  626. app.state.BASE_MODELS = []
  627. ########################################
  628. #
  629. # WEBUI
  630. #
  631. ########################################
  632. app.state.config.WEBUI_URL = WEBUI_URL
  633. app.state.config.ENABLE_SIGNUP = ENABLE_SIGNUP
  634. app.state.config.ENABLE_LOGIN_FORM = ENABLE_LOGIN_FORM
  635. app.state.config.ENABLE_API_KEY = ENABLE_API_KEY
  636. app.state.config.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS = (
  637. ENABLE_API_KEY_ENDPOINT_RESTRICTIONS
  638. )
  639. app.state.config.API_KEY_ALLOWED_ENDPOINTS = API_KEY_ALLOWED_ENDPOINTS
  640. app.state.config.JWT_EXPIRES_IN = JWT_EXPIRES_IN
  641. app.state.config.SHOW_ADMIN_DETAILS = SHOW_ADMIN_DETAILS
  642. app.state.config.ADMIN_EMAIL = ADMIN_EMAIL
  643. app.state.config.DEFAULT_MODELS = DEFAULT_MODELS
  644. app.state.config.DEFAULT_PROMPT_SUGGESTIONS = DEFAULT_PROMPT_SUGGESTIONS
  645. app.state.config.DEFAULT_USER_ROLE = DEFAULT_USER_ROLE
  646. app.state.config.PENDING_USER_OVERLAY_CONTENT = PENDING_USER_OVERLAY_CONTENT
  647. app.state.config.PENDING_USER_OVERLAY_TITLE = PENDING_USER_OVERLAY_TITLE
  648. app.state.config.RESPONSE_WATERMARK = RESPONSE_WATERMARK
  649. app.state.config.USER_PERMISSIONS = USER_PERMISSIONS
  650. app.state.config.WEBHOOK_URL = WEBHOOK_URL
  651. app.state.config.BANNERS = WEBUI_BANNERS
  652. app.state.config.MODEL_ORDER_LIST = MODEL_ORDER_LIST
  653. app.state.config.ENABLE_CHANNELS = ENABLE_CHANNELS
  654. app.state.config.ENABLE_NOTES = ENABLE_NOTES
  655. app.state.config.ENABLE_COMMUNITY_SHARING = ENABLE_COMMUNITY_SHARING
  656. app.state.config.ENABLE_MESSAGE_RATING = ENABLE_MESSAGE_RATING
  657. app.state.config.ENABLE_USER_WEBHOOKS = ENABLE_USER_WEBHOOKS
  658. app.state.config.ENABLE_EVALUATION_ARENA_MODELS = ENABLE_EVALUATION_ARENA_MODELS
  659. app.state.config.EVALUATION_ARENA_MODELS = EVALUATION_ARENA_MODELS
  660. app.state.config.OAUTH_USERNAME_CLAIM = OAUTH_USERNAME_CLAIM
  661. app.state.config.OAUTH_PICTURE_CLAIM = OAUTH_PICTURE_CLAIM
  662. app.state.config.OAUTH_EMAIL_CLAIM = OAUTH_EMAIL_CLAIM
  663. app.state.config.ENABLE_OAUTH_ROLE_MANAGEMENT = ENABLE_OAUTH_ROLE_MANAGEMENT
  664. app.state.config.OAUTH_ROLES_CLAIM = OAUTH_ROLES_CLAIM
  665. app.state.config.OAUTH_ALLOWED_ROLES = OAUTH_ALLOWED_ROLES
  666. app.state.config.OAUTH_ADMIN_ROLES = OAUTH_ADMIN_ROLES
  667. app.state.config.ENABLE_LDAP = ENABLE_LDAP
  668. app.state.config.LDAP_SERVER_LABEL = LDAP_SERVER_LABEL
  669. app.state.config.LDAP_SERVER_HOST = LDAP_SERVER_HOST
  670. app.state.config.LDAP_SERVER_PORT = LDAP_SERVER_PORT
  671. app.state.config.LDAP_ATTRIBUTE_FOR_MAIL = LDAP_ATTRIBUTE_FOR_MAIL
  672. app.state.config.LDAP_ATTRIBUTE_FOR_USERNAME = LDAP_ATTRIBUTE_FOR_USERNAME
  673. app.state.config.LDAP_APP_DN = LDAP_APP_DN
  674. app.state.config.LDAP_APP_PASSWORD = LDAP_APP_PASSWORD
  675. app.state.config.LDAP_SEARCH_BASE = LDAP_SEARCH_BASE
  676. app.state.config.LDAP_SEARCH_FILTERS = LDAP_SEARCH_FILTERS
  677. app.state.config.LDAP_USE_TLS = LDAP_USE_TLS
  678. app.state.config.LDAP_CA_CERT_FILE = LDAP_CA_CERT_FILE
  679. app.state.config.LDAP_VALIDATE_CERT = LDAP_VALIDATE_CERT
  680. app.state.config.LDAP_CIPHERS = LDAP_CIPHERS
  681. # For LDAP Group Management
  682. app.state.config.ENABLE_LDAP_GROUP_MANAGEMENT = ENABLE_LDAP_GROUP_MANAGEMENT
  683. app.state.config.ENABLE_LDAP_GROUP_CREATION = ENABLE_LDAP_GROUP_CREATION
  684. app.state.config.LDAP_ATTRIBUTE_FOR_GROUPS = LDAP_ATTRIBUTE_FOR_GROUPS
  685. app.state.AUTH_TRUSTED_EMAIL_HEADER = WEBUI_AUTH_TRUSTED_EMAIL_HEADER
  686. app.state.AUTH_TRUSTED_NAME_HEADER = WEBUI_AUTH_TRUSTED_NAME_HEADER
  687. app.state.WEBUI_AUTH_SIGNOUT_REDIRECT_URL = WEBUI_AUTH_SIGNOUT_REDIRECT_URL
  688. app.state.EXTERNAL_PWA_MANIFEST_URL = EXTERNAL_PWA_MANIFEST_URL
  689. app.state.USER_COUNT = None
  690. app.state.TOOLS = {}
  691. app.state.TOOL_CONTENTS = {}
  692. app.state.FUNCTIONS = {}
  693. app.state.FUNCTION_CONTENTS = {}
  694. ########################################
  695. #
  696. # RETRIEVAL
  697. #
  698. ########################################
  699. app.state.config.TOP_K = RAG_TOP_K
  700. app.state.config.TOP_K_RERANKER = RAG_TOP_K_RERANKER
  701. app.state.config.RELEVANCE_THRESHOLD = RAG_RELEVANCE_THRESHOLD
  702. app.state.config.HYBRID_BM25_WEIGHT = RAG_HYBRID_BM25_WEIGHT
  703. app.state.config.ALLOWED_FILE_EXTENSIONS = RAG_ALLOWED_FILE_EXTENSIONS
  704. app.state.config.FILE_MAX_SIZE = RAG_FILE_MAX_SIZE
  705. app.state.config.FILE_MAX_COUNT = RAG_FILE_MAX_COUNT
  706. app.state.config.FILE_IMAGE_COMPRESSION_WIDTH = FILE_IMAGE_COMPRESSION_WIDTH
  707. app.state.config.FILE_IMAGE_COMPRESSION_HEIGHT = FILE_IMAGE_COMPRESSION_HEIGHT
  708. app.state.config.RAG_FULL_CONTEXT = RAG_FULL_CONTEXT
  709. app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL = BYPASS_EMBEDDING_AND_RETRIEVAL
  710. app.state.config.ENABLE_RAG_HYBRID_SEARCH = ENABLE_RAG_HYBRID_SEARCH
  711. app.state.config.ENABLE_WEB_LOADER_SSL_VERIFICATION = ENABLE_WEB_LOADER_SSL_VERIFICATION
  712. app.state.config.CONTENT_EXTRACTION_ENGINE = CONTENT_EXTRACTION_ENGINE
  713. app.state.config.DATALAB_MARKER_API_KEY = DATALAB_MARKER_API_KEY
  714. app.state.config.DATALAB_MARKER_API_BASE_URL = DATALAB_MARKER_API_BASE_URL
  715. app.state.config.DATALAB_MARKER_ADDITIONAL_CONFIG = DATALAB_MARKER_ADDITIONAL_CONFIG
  716. app.state.config.DATALAB_MARKER_SKIP_CACHE = DATALAB_MARKER_SKIP_CACHE
  717. app.state.config.DATALAB_MARKER_FORCE_OCR = DATALAB_MARKER_FORCE_OCR
  718. app.state.config.DATALAB_MARKER_PAGINATE = DATALAB_MARKER_PAGINATE
  719. app.state.config.DATALAB_MARKER_STRIP_EXISTING_OCR = DATALAB_MARKER_STRIP_EXISTING_OCR
  720. app.state.config.DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION = (
  721. DATALAB_MARKER_DISABLE_IMAGE_EXTRACTION
  722. )
  723. app.state.config.DATALAB_MARKER_FORMAT_LINES = DATALAB_MARKER_FORMAT_LINES
  724. app.state.config.DATALAB_MARKER_USE_LLM = DATALAB_MARKER_USE_LLM
  725. app.state.config.DATALAB_MARKER_OUTPUT_FORMAT = DATALAB_MARKER_OUTPUT_FORMAT
  726. app.state.config.EXTERNAL_DOCUMENT_LOADER_URL = EXTERNAL_DOCUMENT_LOADER_URL
  727. app.state.config.EXTERNAL_DOCUMENT_LOADER_API_KEY = EXTERNAL_DOCUMENT_LOADER_API_KEY
  728. app.state.config.TIKA_SERVER_URL = TIKA_SERVER_URL
  729. app.state.config.DOCLING_SERVER_URL = DOCLING_SERVER_URL
  730. app.state.config.DOCLING_DO_OCR = DOCLING_DO_OCR
  731. app.state.config.DOCLING_FORCE_OCR = DOCLING_FORCE_OCR
  732. app.state.config.DOCLING_OCR_ENGINE = DOCLING_OCR_ENGINE
  733. app.state.config.DOCLING_OCR_LANG = DOCLING_OCR_LANG
  734. app.state.config.DOCLING_PDF_BACKEND = DOCLING_PDF_BACKEND
  735. app.state.config.DOCLING_TABLE_MODE = DOCLING_TABLE_MODE
  736. app.state.config.DOCLING_PIPELINE = DOCLING_PIPELINE
  737. app.state.config.DOCLING_DO_PICTURE_DESCRIPTION = DOCLING_DO_PICTURE_DESCRIPTION
  738. app.state.config.DOCLING_PICTURE_DESCRIPTION_MODE = DOCLING_PICTURE_DESCRIPTION_MODE
  739. app.state.config.DOCLING_PICTURE_DESCRIPTION_LOCAL = DOCLING_PICTURE_DESCRIPTION_LOCAL
  740. app.state.config.DOCLING_PICTURE_DESCRIPTION_API = DOCLING_PICTURE_DESCRIPTION_API
  741. app.state.config.DOCUMENT_INTELLIGENCE_ENDPOINT = DOCUMENT_INTELLIGENCE_ENDPOINT
  742. app.state.config.DOCUMENT_INTELLIGENCE_KEY = DOCUMENT_INTELLIGENCE_KEY
  743. app.state.config.MISTRAL_OCR_API_KEY = MISTRAL_OCR_API_KEY
  744. app.state.config.TEXT_SPLITTER = RAG_TEXT_SPLITTER
  745. app.state.config.TIKTOKEN_ENCODING_NAME = TIKTOKEN_ENCODING_NAME
  746. app.state.config.CHUNK_SIZE = CHUNK_SIZE
  747. app.state.config.CHUNK_OVERLAP = CHUNK_OVERLAP
  748. app.state.config.RAG_EMBEDDING_ENGINE = RAG_EMBEDDING_ENGINE
  749. app.state.config.RAG_EMBEDDING_MODEL = RAG_EMBEDDING_MODEL
  750. app.state.config.RAG_EMBEDDING_BATCH_SIZE = RAG_EMBEDDING_BATCH_SIZE
  751. app.state.config.RAG_RERANKING_ENGINE = RAG_RERANKING_ENGINE
  752. app.state.config.RAG_RERANKING_MODEL = RAG_RERANKING_MODEL
  753. app.state.config.RAG_EXTERNAL_RERANKER_URL = RAG_EXTERNAL_RERANKER_URL
  754. app.state.config.RAG_EXTERNAL_RERANKER_API_KEY = RAG_EXTERNAL_RERANKER_API_KEY
  755. app.state.config.RAG_TEMPLATE = RAG_TEMPLATE
  756. app.state.config.RAG_OPENAI_API_BASE_URL = RAG_OPENAI_API_BASE_URL
  757. app.state.config.RAG_OPENAI_API_KEY = RAG_OPENAI_API_KEY
  758. app.state.config.RAG_AZURE_OPENAI_BASE_URL = RAG_AZURE_OPENAI_BASE_URL
  759. app.state.config.RAG_AZURE_OPENAI_API_KEY = RAG_AZURE_OPENAI_API_KEY
  760. app.state.config.RAG_AZURE_OPENAI_API_VERSION = RAG_AZURE_OPENAI_API_VERSION
  761. app.state.config.RAG_OLLAMA_BASE_URL = RAG_OLLAMA_BASE_URL
  762. app.state.config.RAG_OLLAMA_API_KEY = RAG_OLLAMA_API_KEY
  763. app.state.config.PDF_EXTRACT_IMAGES = PDF_EXTRACT_IMAGES
  764. app.state.config.YOUTUBE_LOADER_LANGUAGE = YOUTUBE_LOADER_LANGUAGE
  765. app.state.config.YOUTUBE_LOADER_PROXY_URL = YOUTUBE_LOADER_PROXY_URL
  766. app.state.config.ENABLE_WEB_SEARCH = ENABLE_WEB_SEARCH
  767. app.state.config.WEB_SEARCH_ENGINE = WEB_SEARCH_ENGINE
  768. app.state.config.WEB_SEARCH_DOMAIN_FILTER_LIST = WEB_SEARCH_DOMAIN_FILTER_LIST
  769. app.state.config.WEB_SEARCH_RESULT_COUNT = WEB_SEARCH_RESULT_COUNT
  770. app.state.config.WEB_SEARCH_CONCURRENT_REQUESTS = WEB_SEARCH_CONCURRENT_REQUESTS
  771. app.state.config.WEB_LOADER_ENGINE = WEB_LOADER_ENGINE
  772. app.state.config.WEB_LOADER_CONCURRENT_REQUESTS = WEB_LOADER_CONCURRENT_REQUESTS
  773. app.state.config.WEB_SEARCH_TRUST_ENV = WEB_SEARCH_TRUST_ENV
  774. app.state.config.BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL = (
  775. BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL
  776. )
  777. app.state.config.BYPASS_WEB_SEARCH_WEB_LOADER = BYPASS_WEB_SEARCH_WEB_LOADER
  778. app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION = ENABLE_GOOGLE_DRIVE_INTEGRATION
  779. app.state.config.ENABLE_ONEDRIVE_INTEGRATION = ENABLE_ONEDRIVE_INTEGRATION
  780. app.state.config.OLLAMA_CLOUD_WEB_SEARCH_API_KEY = OLLAMA_CLOUD_WEB_SEARCH_API_KEY
  781. app.state.config.SEARXNG_QUERY_URL = SEARXNG_QUERY_URL
  782. app.state.config.YACY_QUERY_URL = YACY_QUERY_URL
  783. app.state.config.YACY_USERNAME = YACY_USERNAME
  784. app.state.config.YACY_PASSWORD = YACY_PASSWORD
  785. app.state.config.GOOGLE_PSE_API_KEY = GOOGLE_PSE_API_KEY
  786. app.state.config.GOOGLE_PSE_ENGINE_ID = GOOGLE_PSE_ENGINE_ID
  787. app.state.config.BRAVE_SEARCH_API_KEY = BRAVE_SEARCH_API_KEY
  788. app.state.config.KAGI_SEARCH_API_KEY = KAGI_SEARCH_API_KEY
  789. app.state.config.MOJEEK_SEARCH_API_KEY = MOJEEK_SEARCH_API_KEY
  790. app.state.config.BOCHA_SEARCH_API_KEY = BOCHA_SEARCH_API_KEY
  791. app.state.config.SERPSTACK_API_KEY = SERPSTACK_API_KEY
  792. app.state.config.SERPSTACK_HTTPS = SERPSTACK_HTTPS
  793. app.state.config.SERPER_API_KEY = SERPER_API_KEY
  794. app.state.config.SERPLY_API_KEY = SERPLY_API_KEY
  795. app.state.config.TAVILY_API_KEY = TAVILY_API_KEY
  796. app.state.config.SEARCHAPI_API_KEY = SEARCHAPI_API_KEY
  797. app.state.config.SEARCHAPI_ENGINE = SEARCHAPI_ENGINE
  798. app.state.config.SERPAPI_API_KEY = SERPAPI_API_KEY
  799. app.state.config.SERPAPI_ENGINE = SERPAPI_ENGINE
  800. app.state.config.JINA_API_KEY = JINA_API_KEY
  801. app.state.config.BING_SEARCH_V7_ENDPOINT = BING_SEARCH_V7_ENDPOINT
  802. app.state.config.BING_SEARCH_V7_SUBSCRIPTION_KEY = BING_SEARCH_V7_SUBSCRIPTION_KEY
  803. app.state.config.EXA_API_KEY = EXA_API_KEY
  804. app.state.config.PERPLEXITY_API_KEY = PERPLEXITY_API_KEY
  805. app.state.config.PERPLEXITY_MODEL = PERPLEXITY_MODEL
  806. app.state.config.PERPLEXITY_SEARCH_CONTEXT_USAGE = PERPLEXITY_SEARCH_CONTEXT_USAGE
  807. app.state.config.SOUGOU_API_SID = SOUGOU_API_SID
  808. app.state.config.SOUGOU_API_SK = SOUGOU_API_SK
  809. app.state.config.EXTERNAL_WEB_SEARCH_URL = EXTERNAL_WEB_SEARCH_URL
  810. app.state.config.EXTERNAL_WEB_SEARCH_API_KEY = EXTERNAL_WEB_SEARCH_API_KEY
  811. app.state.config.EXTERNAL_WEB_LOADER_URL = EXTERNAL_WEB_LOADER_URL
  812. app.state.config.EXTERNAL_WEB_LOADER_API_KEY = EXTERNAL_WEB_LOADER_API_KEY
  813. app.state.config.PLAYWRIGHT_WS_URL = PLAYWRIGHT_WS_URL
  814. app.state.config.PLAYWRIGHT_TIMEOUT = PLAYWRIGHT_TIMEOUT
  815. app.state.config.FIRECRAWL_API_BASE_URL = FIRECRAWL_API_BASE_URL
  816. app.state.config.FIRECRAWL_API_KEY = FIRECRAWL_API_KEY
  817. app.state.config.TAVILY_EXTRACT_DEPTH = TAVILY_EXTRACT_DEPTH
  818. app.state.EMBEDDING_FUNCTION = None
  819. app.state.RERANKING_FUNCTION = None
  820. app.state.ef = None
  821. app.state.rf = None
  822. app.state.YOUTUBE_LOADER_TRANSLATION = None
  823. try:
  824. app.state.ef = get_ef(
  825. app.state.config.RAG_EMBEDDING_ENGINE,
  826. app.state.config.RAG_EMBEDDING_MODEL,
  827. RAG_EMBEDDING_MODEL_AUTO_UPDATE,
  828. )
  829. if (
  830. app.state.config.ENABLE_RAG_HYBRID_SEARCH
  831. and not app.state.config.BYPASS_EMBEDDING_AND_RETRIEVAL
  832. ):
  833. app.state.rf = get_rf(
  834. app.state.config.RAG_RERANKING_ENGINE,
  835. app.state.config.RAG_RERANKING_MODEL,
  836. app.state.config.RAG_EXTERNAL_RERANKER_URL,
  837. app.state.config.RAG_EXTERNAL_RERANKER_API_KEY,
  838. RAG_RERANKING_MODEL_AUTO_UPDATE,
  839. )
  840. else:
  841. app.state.rf = None
  842. except Exception as e:
  843. log.error(f"Error updating models: {e}")
  844. pass
  845. app.state.EMBEDDING_FUNCTION = get_embedding_function(
  846. app.state.config.RAG_EMBEDDING_ENGINE,
  847. app.state.config.RAG_EMBEDDING_MODEL,
  848. embedding_function=app.state.ef,
  849. url=(
  850. app.state.config.RAG_OPENAI_API_BASE_URL
  851. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  852. else (
  853. app.state.config.RAG_OLLAMA_BASE_URL
  854. if app.state.config.RAG_EMBEDDING_ENGINE == "ollama"
  855. else app.state.config.RAG_AZURE_OPENAI_BASE_URL
  856. )
  857. ),
  858. key=(
  859. app.state.config.RAG_OPENAI_API_KEY
  860. if app.state.config.RAG_EMBEDDING_ENGINE == "openai"
  861. else (
  862. app.state.config.RAG_OLLAMA_API_KEY
  863. if app.state.config.RAG_EMBEDDING_ENGINE == "ollama"
  864. else app.state.config.RAG_AZURE_OPENAI_API_KEY
  865. )
  866. ),
  867. embedding_batch_size=app.state.config.RAG_EMBEDDING_BATCH_SIZE,
  868. azure_api_version=(
  869. app.state.config.RAG_AZURE_OPENAI_API_VERSION
  870. if app.state.config.RAG_EMBEDDING_ENGINE == "azure_openai"
  871. else None
  872. ),
  873. )
  874. app.state.RERANKING_FUNCTION = get_reranking_function(
  875. app.state.config.RAG_RERANKING_ENGINE,
  876. app.state.config.RAG_RERANKING_MODEL,
  877. reranking_function=app.state.rf,
  878. )
  879. ########################################
  880. #
  881. # CODE EXECUTION
  882. #
  883. ########################################
  884. app.state.config.ENABLE_CODE_EXECUTION = ENABLE_CODE_EXECUTION
  885. app.state.config.CODE_EXECUTION_ENGINE = CODE_EXECUTION_ENGINE
  886. app.state.config.CODE_EXECUTION_JUPYTER_URL = CODE_EXECUTION_JUPYTER_URL
  887. app.state.config.CODE_EXECUTION_JUPYTER_AUTH = CODE_EXECUTION_JUPYTER_AUTH
  888. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_TOKEN = CODE_EXECUTION_JUPYTER_AUTH_TOKEN
  889. app.state.config.CODE_EXECUTION_JUPYTER_AUTH_PASSWORD = (
  890. CODE_EXECUTION_JUPYTER_AUTH_PASSWORD
  891. )
  892. app.state.config.CODE_EXECUTION_JUPYTER_TIMEOUT = CODE_EXECUTION_JUPYTER_TIMEOUT
  893. app.state.config.ENABLE_CODE_INTERPRETER = ENABLE_CODE_INTERPRETER
  894. app.state.config.CODE_INTERPRETER_ENGINE = CODE_INTERPRETER_ENGINE
  895. app.state.config.CODE_INTERPRETER_PROMPT_TEMPLATE = CODE_INTERPRETER_PROMPT_TEMPLATE
  896. app.state.config.CODE_INTERPRETER_JUPYTER_URL = CODE_INTERPRETER_JUPYTER_URL
  897. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH = CODE_INTERPRETER_JUPYTER_AUTH
  898. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_TOKEN = (
  899. CODE_INTERPRETER_JUPYTER_AUTH_TOKEN
  900. )
  901. app.state.config.CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD = (
  902. CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD
  903. )
  904. app.state.config.CODE_INTERPRETER_JUPYTER_TIMEOUT = CODE_INTERPRETER_JUPYTER_TIMEOUT
  905. ########################################
  906. #
  907. # IMAGES
  908. #
  909. ########################################
  910. app.state.config.IMAGE_GENERATION_ENGINE = IMAGE_GENERATION_ENGINE
  911. app.state.config.ENABLE_IMAGE_GENERATION = ENABLE_IMAGE_GENERATION
  912. app.state.config.ENABLE_IMAGE_PROMPT_GENERATION = ENABLE_IMAGE_PROMPT_GENERATION
  913. app.state.config.IMAGES_OPENAI_API_BASE_URL = IMAGES_OPENAI_API_BASE_URL
  914. app.state.config.IMAGES_OPENAI_API_VERSION = IMAGES_OPENAI_API_VERSION
  915. app.state.config.IMAGES_OPENAI_API_KEY = IMAGES_OPENAI_API_KEY
  916. app.state.config.IMAGES_GEMINI_API_BASE_URL = IMAGES_GEMINI_API_BASE_URL
  917. app.state.config.IMAGES_GEMINI_API_KEY = IMAGES_GEMINI_API_KEY
  918. app.state.config.IMAGE_GENERATION_MODEL = IMAGE_GENERATION_MODEL
  919. app.state.config.AUTOMATIC1111_BASE_URL = AUTOMATIC1111_BASE_URL
  920. app.state.config.AUTOMATIC1111_API_AUTH = AUTOMATIC1111_API_AUTH
  921. app.state.config.AUTOMATIC1111_CFG_SCALE = AUTOMATIC1111_CFG_SCALE
  922. app.state.config.AUTOMATIC1111_SAMPLER = AUTOMATIC1111_SAMPLER
  923. app.state.config.AUTOMATIC1111_SCHEDULER = AUTOMATIC1111_SCHEDULER
  924. app.state.config.COMFYUI_BASE_URL = COMFYUI_BASE_URL
  925. app.state.config.COMFYUI_API_KEY = COMFYUI_API_KEY
  926. app.state.config.COMFYUI_WORKFLOW = COMFYUI_WORKFLOW
  927. app.state.config.COMFYUI_WORKFLOW_NODES = COMFYUI_WORKFLOW_NODES
  928. app.state.config.IMAGE_SIZE = IMAGE_SIZE
  929. app.state.config.IMAGE_STEPS = IMAGE_STEPS
  930. ########################################
  931. #
  932. # AUDIO
  933. #
  934. ########################################
  935. app.state.config.STT_ENGINE = AUDIO_STT_ENGINE
  936. app.state.config.STT_MODEL = AUDIO_STT_MODEL
  937. app.state.config.STT_SUPPORTED_CONTENT_TYPES = AUDIO_STT_SUPPORTED_CONTENT_TYPES
  938. app.state.config.STT_OPENAI_API_BASE_URL = AUDIO_STT_OPENAI_API_BASE_URL
  939. app.state.config.STT_OPENAI_API_KEY = AUDIO_STT_OPENAI_API_KEY
  940. app.state.config.WHISPER_MODEL = WHISPER_MODEL
  941. app.state.config.WHISPER_VAD_FILTER = WHISPER_VAD_FILTER
  942. app.state.config.DEEPGRAM_API_KEY = DEEPGRAM_API_KEY
  943. app.state.config.AUDIO_STT_AZURE_API_KEY = AUDIO_STT_AZURE_API_KEY
  944. app.state.config.AUDIO_STT_AZURE_REGION = AUDIO_STT_AZURE_REGION
  945. app.state.config.AUDIO_STT_AZURE_LOCALES = AUDIO_STT_AZURE_LOCALES
  946. app.state.config.AUDIO_STT_AZURE_BASE_URL = AUDIO_STT_AZURE_BASE_URL
  947. app.state.config.AUDIO_STT_AZURE_MAX_SPEAKERS = AUDIO_STT_AZURE_MAX_SPEAKERS
  948. app.state.config.TTS_OPENAI_API_BASE_URL = AUDIO_TTS_OPENAI_API_BASE_URL
  949. app.state.config.TTS_OPENAI_API_KEY = AUDIO_TTS_OPENAI_API_KEY
  950. app.state.config.TTS_ENGINE = AUDIO_TTS_ENGINE
  951. app.state.config.TTS_MODEL = AUDIO_TTS_MODEL
  952. app.state.config.TTS_VOICE = AUDIO_TTS_VOICE
  953. app.state.config.TTS_API_KEY = AUDIO_TTS_API_KEY
  954. app.state.config.TTS_SPLIT_ON = AUDIO_TTS_SPLIT_ON
  955. app.state.config.TTS_AZURE_SPEECH_REGION = AUDIO_TTS_AZURE_SPEECH_REGION
  956. app.state.config.TTS_AZURE_SPEECH_BASE_URL = AUDIO_TTS_AZURE_SPEECH_BASE_URL
  957. app.state.config.TTS_AZURE_SPEECH_OUTPUT_FORMAT = AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT
  958. app.state.faster_whisper_model = None
  959. app.state.speech_synthesiser = None
  960. app.state.speech_speaker_embeddings_dataset = None
  961. ########################################
  962. #
  963. # TASKS
  964. #
  965. ########################################
  966. app.state.config.TASK_MODEL = TASK_MODEL
  967. app.state.config.TASK_MODEL_EXTERNAL = TASK_MODEL_EXTERNAL
  968. app.state.config.ENABLE_SEARCH_QUERY_GENERATION = ENABLE_SEARCH_QUERY_GENERATION
  969. app.state.config.ENABLE_RETRIEVAL_QUERY_GENERATION = ENABLE_RETRIEVAL_QUERY_GENERATION
  970. app.state.config.ENABLE_AUTOCOMPLETE_GENERATION = ENABLE_AUTOCOMPLETE_GENERATION
  971. app.state.config.ENABLE_TAGS_GENERATION = ENABLE_TAGS_GENERATION
  972. app.state.config.ENABLE_TITLE_GENERATION = ENABLE_TITLE_GENERATION
  973. app.state.config.ENABLE_FOLLOW_UP_GENERATION = ENABLE_FOLLOW_UP_GENERATION
  974. app.state.config.TITLE_GENERATION_PROMPT_TEMPLATE = TITLE_GENERATION_PROMPT_TEMPLATE
  975. app.state.config.TAGS_GENERATION_PROMPT_TEMPLATE = TAGS_GENERATION_PROMPT_TEMPLATE
  976. app.state.config.IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE = (
  977. IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE
  978. )
  979. app.state.config.FOLLOW_UP_GENERATION_PROMPT_TEMPLATE = (
  980. FOLLOW_UP_GENERATION_PROMPT_TEMPLATE
  981. )
  982. app.state.config.TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE = (
  983. TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE
  984. )
  985. app.state.config.QUERY_GENERATION_PROMPT_TEMPLATE = QUERY_GENERATION_PROMPT_TEMPLATE
  986. app.state.config.AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE = (
  987. AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE
  988. )
  989. app.state.config.AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH = (
  990. AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH
  991. )
  992. ########################################
  993. #
  994. # WEBUI
  995. #
  996. ########################################
  997. app.state.MODELS = {}
  998. class RedirectMiddleware(BaseHTTPMiddleware):
  999. async def dispatch(self, request: Request, call_next):
  1000. # Check if the request is a GET request
  1001. if request.method == "GET":
  1002. path = request.url.path
  1003. query_params = dict(parse_qs(urlparse(str(request.url)).query))
  1004. # Check for the specific watch path and the presence of 'v' parameter
  1005. if path.endswith("/watch") and "v" in query_params:
  1006. # Extract the first 'v' parameter
  1007. video_id = query_params["v"][0]
  1008. encoded_video_id = urlencode({"youtube": video_id})
  1009. redirect_url = f"/?{encoded_video_id}"
  1010. return RedirectResponse(url=redirect_url)
  1011. # Proceed with the normal flow of other requests
  1012. response = await call_next(request)
  1013. return response
  1014. # Add the middleware to the app
  1015. if ENABLE_COMPRESSION_MIDDLEWARE:
  1016. app.add_middleware(CompressMiddleware)
  1017. app.add_middleware(RedirectMiddleware)
  1018. app.add_middleware(SecurityHeadersMiddleware)
  1019. @app.middleware("http")
  1020. async def commit_session_after_request(request: Request, call_next):
  1021. response = await call_next(request)
  1022. # log.debug("Commit session after request")
  1023. Session.commit()
  1024. return response
  1025. @app.middleware("http")
  1026. async def check_url(request: Request, call_next):
  1027. start_time = int(time.time())
  1028. request.state.token = get_http_authorization_cred(
  1029. request.headers.get("Authorization")
  1030. )
  1031. request.state.enable_api_key = app.state.config.ENABLE_API_KEY
  1032. response = await call_next(request)
  1033. process_time = int(time.time()) - start_time
  1034. response.headers["X-Process-Time"] = str(process_time)
  1035. return response
  1036. @app.middleware("http")
  1037. async def inspect_websocket(request: Request, call_next):
  1038. if (
  1039. "/ws/socket.io" in request.url.path
  1040. and request.query_params.get("transport") == "websocket"
  1041. ):
  1042. upgrade = (request.headers.get("Upgrade") or "").lower()
  1043. connection = (request.headers.get("Connection") or "").lower().split(",")
  1044. # Check that there's the correct headers for an upgrade, else reject the connection
  1045. # This is to work around this upstream issue: https://github.com/miguelgrinberg/python-engineio/issues/367
  1046. if upgrade != "websocket" or "upgrade" not in connection:
  1047. return JSONResponse(
  1048. status_code=status.HTTP_400_BAD_REQUEST,
  1049. content={"detail": "Invalid WebSocket upgrade request"},
  1050. )
  1051. return await call_next(request)
  1052. app.add_middleware(
  1053. CORSMiddleware,
  1054. allow_origins=CORS_ALLOW_ORIGIN,
  1055. allow_credentials=True,
  1056. allow_methods=["*"],
  1057. allow_headers=["*"],
  1058. )
  1059. app.mount("/ws", socket_app)
  1060. app.include_router(ollama.router, prefix="/ollama", tags=["ollama"])
  1061. app.include_router(openai.router, prefix="/openai", tags=["openai"])
  1062. app.include_router(pipelines.router, prefix="/api/v1/pipelines", tags=["pipelines"])
  1063. app.include_router(tasks.router, prefix="/api/v1/tasks", tags=["tasks"])
  1064. app.include_router(images.router, prefix="/api/v1/images", tags=["images"])
  1065. app.include_router(audio.router, prefix="/api/v1/audio", tags=["audio"])
  1066. app.include_router(retrieval.router, prefix="/api/v1/retrieval", tags=["retrieval"])
  1067. app.include_router(configs.router, prefix="/api/v1/configs", tags=["configs"])
  1068. app.include_router(auths.router, prefix="/api/v1/auths", tags=["auths"])
  1069. app.include_router(users.router, prefix="/api/v1/users", tags=["users"])
  1070. app.include_router(channels.router, prefix="/api/v1/channels", tags=["channels"])
  1071. app.include_router(chats.router, prefix="/api/v1/chats", tags=["chats"])
  1072. app.include_router(notes.router, prefix="/api/v1/notes", tags=["notes"])
  1073. app.include_router(models.router, prefix="/api/v1/models", tags=["models"])
  1074. app.include_router(knowledge.router, prefix="/api/v1/knowledge", tags=["knowledge"])
  1075. app.include_router(prompts.router, prefix="/api/v1/prompts", tags=["prompts"])
  1076. app.include_router(tools.router, prefix="/api/v1/tools", tags=["tools"])
  1077. app.include_router(memories.router, prefix="/api/v1/memories", tags=["memories"])
  1078. app.include_router(folders.router, prefix="/api/v1/folders", tags=["folders"])
  1079. app.include_router(groups.router, prefix="/api/v1/groups", tags=["groups"])
  1080. app.include_router(files.router, prefix="/api/v1/files", tags=["files"])
  1081. app.include_router(functions.router, prefix="/api/v1/functions", tags=["functions"])
  1082. app.include_router(
  1083. evaluations.router, prefix="/api/v1/evaluations", tags=["evaluations"]
  1084. )
  1085. app.include_router(utils.router, prefix="/api/v1/utils", tags=["utils"])
  1086. # SCIM 2.0 API for identity management
  1087. if SCIM_ENABLED:
  1088. app.include_router(scim.router, prefix="/api/v1/scim/v2", tags=["scim"])
  1089. try:
  1090. audit_level = AuditLevel(AUDIT_LOG_LEVEL)
  1091. except ValueError as e:
  1092. logger.error(f"Invalid audit level: {AUDIT_LOG_LEVEL}. Error: {e}")
  1093. audit_level = AuditLevel.NONE
  1094. if audit_level != AuditLevel.NONE:
  1095. app.add_middleware(
  1096. AuditLoggingMiddleware,
  1097. audit_level=audit_level,
  1098. excluded_paths=AUDIT_EXCLUDED_PATHS,
  1099. max_body_size=MAX_BODY_LOG_SIZE,
  1100. )
  1101. ##################################
  1102. #
  1103. # Chat Endpoints
  1104. #
  1105. ##################################
  1106. @app.get("/api/models")
  1107. @app.get("/api/v1/models") # Experimental: Compatibility with OpenAI API
  1108. async def get_models(
  1109. request: Request, refresh: bool = False, user=Depends(get_verified_user)
  1110. ):
  1111. all_models = await get_all_models(request, refresh=refresh, user=user)
  1112. models = []
  1113. for model in all_models:
  1114. # Filter out filter pipelines
  1115. if "pipeline" in model and model["pipeline"].get("type", None) == "filter":
  1116. continue
  1117. try:
  1118. model_tags = [
  1119. tag.get("name")
  1120. for tag in model.get("info", {}).get("meta", {}).get("tags", [])
  1121. ]
  1122. tags = [tag.get("name") for tag in model.get("tags", [])]
  1123. tags = list(set(model_tags + tags))
  1124. model["tags"] = [{"name": tag} for tag in tags]
  1125. except Exception as e:
  1126. log.debug(f"Error processing model tags: {e}")
  1127. model["tags"] = []
  1128. pass
  1129. models.append(model)
  1130. model_order_list = request.app.state.config.MODEL_ORDER_LIST
  1131. if model_order_list:
  1132. model_order_dict = {model_id: i for i, model_id in enumerate(model_order_list)}
  1133. # Sort models by order list priority, with fallback for those not in the list
  1134. models.sort(
  1135. key=lambda model: (
  1136. model_order_dict.get(model.get("id", ""), float("inf")),
  1137. (model.get("name", "") or ""),
  1138. )
  1139. )
  1140. models = get_filtered_models(models, user)
  1141. log.debug(
  1142. f"/api/models returned filtered models accessible to the user: {json.dumps([model.get('id') for model in models])}"
  1143. )
  1144. return {"data": models}
  1145. @app.get("/api/models/base")
  1146. async def get_base_models(request: Request, user=Depends(get_admin_user)):
  1147. models = await get_all_base_models(request, user=user)
  1148. return {"data": models}
  1149. ##################################
  1150. # Embeddings
  1151. ##################################
  1152. @app.post("/api/embeddings")
  1153. @app.post("/api/v1/embeddings") # Experimental: Compatibility with OpenAI API
  1154. async def embeddings(
  1155. request: Request, form_data: dict, user=Depends(get_verified_user)
  1156. ):
  1157. """
  1158. OpenAI-compatible embeddings endpoint.
  1159. This handler:
  1160. - Performs user/model checks and dispatches to the correct backend.
  1161. - Supports OpenAI, Ollama, arena models, pipelines, and any compatible provider.
  1162. Args:
  1163. request (Request): Request context.
  1164. form_data (dict): OpenAI-like payload (e.g., {"model": "...", "input": [...]})
  1165. user (UserModel): Authenticated user.
  1166. Returns:
  1167. dict: OpenAI-compatible embeddings response.
  1168. """
  1169. # Make sure models are loaded in app state
  1170. if not request.app.state.MODELS:
  1171. await get_all_models(request, user=user)
  1172. # Use generic dispatcher in utils.embeddings
  1173. return await generate_embeddings(request, form_data, user)
  1174. @app.post("/api/chat/completions")
  1175. @app.post("/api/v1/chat/completions") # Experimental: Compatibility with OpenAI API
  1176. async def chat_completion(
  1177. request: Request,
  1178. form_data: dict,
  1179. user=Depends(get_verified_user),
  1180. ):
  1181. if not request.app.state.MODELS:
  1182. await get_all_models(request, user=user)
  1183. model_id = form_data.get("model", None)
  1184. model_item = form_data.pop("model_item", {})
  1185. tasks = form_data.pop("background_tasks", None)
  1186. metadata = {}
  1187. try:
  1188. if not model_item.get("direct", False):
  1189. if model_id not in request.app.state.MODELS:
  1190. raise Exception("Model not found")
  1191. model = request.app.state.MODELS[model_id]
  1192. model_info = Models.get_model_by_id(model_id)
  1193. # Check if user has access to the model
  1194. if not BYPASS_MODEL_ACCESS_CONTROL and (
  1195. user.role != "admin" or not BYPASS_ADMIN_ACCESS_CONTROL
  1196. ):
  1197. try:
  1198. check_model_access(user, model)
  1199. except Exception as e:
  1200. raise e
  1201. else:
  1202. model = model_item
  1203. model_info = None
  1204. request.state.direct = True
  1205. request.state.model = model
  1206. model_info_params = (
  1207. model_info.params.model_dump() if model_info and model_info.params else {}
  1208. )
  1209. # Chat Params
  1210. stream_delta_chunk_size = form_data.get("params", {}).get(
  1211. "stream_delta_chunk_size"
  1212. )
  1213. reasoning_tags = form_data.get("params", {}).get("reasoning_tags")
  1214. # Model Params
  1215. if model_info_params.get("stream_delta_chunk_size"):
  1216. stream_delta_chunk_size = model_info_params.get("stream_delta_chunk_size")
  1217. if model_info_params.get("reasoning_tags") is not None:
  1218. reasoning_tags = model_info_params.get("reasoning_tags")
  1219. metadata = {
  1220. "user_id": user.id,
  1221. "chat_id": form_data.pop("chat_id", None),
  1222. "message_id": form_data.pop("id", None),
  1223. "session_id": form_data.pop("session_id", None),
  1224. "filter_ids": form_data.pop("filter_ids", []),
  1225. "tool_ids": form_data.get("tool_ids", None),
  1226. "tool_servers": form_data.pop("tool_servers", None),
  1227. "files": form_data.get("files", None),
  1228. "features": form_data.get("features", {}),
  1229. "variables": form_data.get("variables", {}),
  1230. "model": model,
  1231. "direct": model_item.get("direct", False),
  1232. "params": {
  1233. "stream_delta_chunk_size": stream_delta_chunk_size,
  1234. "reasoning_tags": reasoning_tags,
  1235. "function_calling": (
  1236. "native"
  1237. if (
  1238. form_data.get("params", {}).get("function_calling") == "native"
  1239. or model_info_params.get("function_calling") == "native"
  1240. )
  1241. else "default"
  1242. ),
  1243. },
  1244. }
  1245. if metadata.get("chat_id") and (user and user.role != "admin"):
  1246. if metadata["chat_id"] != "local":
  1247. chat = Chats.get_chat_by_id_and_user_id(metadata["chat_id"], user.id)
  1248. if chat is None:
  1249. raise HTTPException(
  1250. status_code=status.HTTP_404_NOT_FOUND,
  1251. detail=ERROR_MESSAGES.DEFAULT(),
  1252. )
  1253. request.state.metadata = metadata
  1254. form_data["metadata"] = metadata
  1255. except Exception as e:
  1256. log.debug(f"Error processing chat metadata: {e}")
  1257. raise HTTPException(
  1258. status_code=status.HTTP_400_BAD_REQUEST,
  1259. detail=str(e),
  1260. )
  1261. async def process_chat(request, form_data, user, metadata, model):
  1262. try:
  1263. form_data, metadata, events = await process_chat_payload(
  1264. request, form_data, user, metadata, model
  1265. )
  1266. response = await chat_completion_handler(request, form_data, user)
  1267. if metadata.get("chat_id") and metadata.get("message_id"):
  1268. try:
  1269. Chats.upsert_message_to_chat_by_id_and_message_id(
  1270. metadata["chat_id"],
  1271. metadata["message_id"],
  1272. {
  1273. "model": model_id,
  1274. },
  1275. )
  1276. except:
  1277. pass
  1278. return await process_chat_response(
  1279. request, response, form_data, user, metadata, model, events, tasks
  1280. )
  1281. except asyncio.CancelledError:
  1282. log.info("Chat processing was cancelled")
  1283. try:
  1284. event_emitter = get_event_emitter(metadata)
  1285. await event_emitter(
  1286. {"type": "chat:tasks:cancel"},
  1287. )
  1288. except Exception as e:
  1289. pass
  1290. except Exception as e:
  1291. log.debug(f"Error processing chat payload: {e}")
  1292. if metadata.get("chat_id") and metadata.get("message_id"):
  1293. # Update the chat message with the error
  1294. try:
  1295. Chats.upsert_message_to_chat_by_id_and_message_id(
  1296. metadata["chat_id"],
  1297. metadata["message_id"],
  1298. {
  1299. "error": {"content": str(e)},
  1300. },
  1301. )
  1302. event_emitter = get_event_emitter(metadata)
  1303. await event_emitter(
  1304. {
  1305. "type": "chat:message:error",
  1306. "data": {"error": {"content": str(e)}},
  1307. }
  1308. )
  1309. await event_emitter(
  1310. {"type": "chat:tasks:cancel"},
  1311. )
  1312. except:
  1313. pass
  1314. finally:
  1315. try:
  1316. if mcp_clients := metadata.get("mcp_clients"):
  1317. for client in mcp_clients:
  1318. await client.disconnect()
  1319. except Exception as e:
  1320. log.debug(f"Error cleaning up: {e}")
  1321. pass
  1322. if (
  1323. metadata.get("session_id")
  1324. and metadata.get("chat_id")
  1325. and metadata.get("message_id")
  1326. ):
  1327. # Asynchronous Chat Processing
  1328. task_id, _ = await create_task(
  1329. request.app.state.redis,
  1330. process_chat(request, form_data, user, metadata, model),
  1331. id=metadata["chat_id"],
  1332. )
  1333. return {"status": True, "task_id": task_id}
  1334. else:
  1335. return await process_chat(request, form_data, user, metadata, model)
  1336. # Alias for chat_completion (Legacy)
  1337. generate_chat_completions = chat_completion
  1338. generate_chat_completion = chat_completion
  1339. @app.post("/api/chat/completed")
  1340. async def chat_completed(
  1341. request: Request, form_data: dict, user=Depends(get_verified_user)
  1342. ):
  1343. try:
  1344. model_item = form_data.pop("model_item", {})
  1345. if model_item.get("direct", False):
  1346. request.state.direct = True
  1347. request.state.model = model_item
  1348. return await chat_completed_handler(request, form_data, user)
  1349. except Exception as e:
  1350. raise HTTPException(
  1351. status_code=status.HTTP_400_BAD_REQUEST,
  1352. detail=str(e),
  1353. )
  1354. @app.post("/api/chat/actions/{action_id}")
  1355. async def chat_action(
  1356. request: Request, action_id: str, form_data: dict, user=Depends(get_verified_user)
  1357. ):
  1358. try:
  1359. model_item = form_data.pop("model_item", {})
  1360. if model_item.get("direct", False):
  1361. request.state.direct = True
  1362. request.state.model = model_item
  1363. return await chat_action_handler(request, action_id, form_data, user)
  1364. except Exception as e:
  1365. raise HTTPException(
  1366. status_code=status.HTTP_400_BAD_REQUEST,
  1367. detail=str(e),
  1368. )
  1369. @app.post("/api/tasks/stop/{task_id}")
  1370. async def stop_task_endpoint(
  1371. request: Request, task_id: str, user=Depends(get_verified_user)
  1372. ):
  1373. try:
  1374. result = await stop_task(request.app.state.redis, task_id)
  1375. return result
  1376. except ValueError as e:
  1377. raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(e))
  1378. @app.get("/api/tasks")
  1379. async def list_tasks_endpoint(request: Request, user=Depends(get_verified_user)):
  1380. return {"tasks": await list_tasks(request.app.state.redis)}
  1381. @app.get("/api/tasks/chat/{chat_id}")
  1382. async def list_tasks_by_chat_id_endpoint(
  1383. request: Request, chat_id: str, user=Depends(get_verified_user)
  1384. ):
  1385. chat = Chats.get_chat_by_id(chat_id)
  1386. if chat is None or chat.user_id != user.id:
  1387. return {"task_ids": []}
  1388. task_ids = await list_task_ids_by_item_id(request.app.state.redis, chat_id)
  1389. log.debug(f"Task IDs for chat {chat_id}: {task_ids}")
  1390. return {"task_ids": task_ids}
  1391. ##################################
  1392. #
  1393. # Config Endpoints
  1394. #
  1395. ##################################
  1396. @app.get("/api/config")
  1397. async def get_app_config(request: Request):
  1398. user = None
  1399. token = None
  1400. auth_header = request.headers.get("Authorization")
  1401. if auth_header:
  1402. cred = get_http_authorization_cred(auth_header)
  1403. if cred:
  1404. token = cred.credentials
  1405. if not token and "token" in request.cookies:
  1406. token = request.cookies.get("token")
  1407. if token:
  1408. try:
  1409. data = decode_token(token)
  1410. except Exception as e:
  1411. log.debug(e)
  1412. raise HTTPException(
  1413. status_code=status.HTTP_401_UNAUTHORIZED,
  1414. detail="Invalid token",
  1415. )
  1416. if data is not None and "id" in data:
  1417. user = Users.get_user_by_id(data["id"])
  1418. user_count = Users.get_num_users()
  1419. onboarding = False
  1420. if user is None:
  1421. onboarding = user_count == 0
  1422. return {
  1423. **({"onboarding": True} if onboarding else {}),
  1424. "status": True,
  1425. "name": app.state.WEBUI_NAME,
  1426. "version": VERSION,
  1427. "default_locale": str(DEFAULT_LOCALE),
  1428. "oauth": {
  1429. "providers": {
  1430. name: config.get("name", name)
  1431. for name, config in OAUTH_PROVIDERS.items()
  1432. }
  1433. },
  1434. "features": {
  1435. "auth": WEBUI_AUTH,
  1436. "auth_trusted_header": bool(app.state.AUTH_TRUSTED_EMAIL_HEADER),
  1437. "enable_signup_password_confirmation": ENABLE_SIGNUP_PASSWORD_CONFIRMATION,
  1438. "enable_ldap": app.state.config.ENABLE_LDAP,
  1439. "enable_api_key": app.state.config.ENABLE_API_KEY,
  1440. "enable_signup": app.state.config.ENABLE_SIGNUP,
  1441. "enable_login_form": app.state.config.ENABLE_LOGIN_FORM,
  1442. "enable_websocket": ENABLE_WEBSOCKET_SUPPORT,
  1443. "enable_version_update_check": ENABLE_VERSION_UPDATE_CHECK,
  1444. **(
  1445. {
  1446. "enable_direct_connections": app.state.config.ENABLE_DIRECT_CONNECTIONS,
  1447. "enable_channels": app.state.config.ENABLE_CHANNELS,
  1448. "enable_notes": app.state.config.ENABLE_NOTES,
  1449. "enable_web_search": app.state.config.ENABLE_WEB_SEARCH,
  1450. "enable_code_execution": app.state.config.ENABLE_CODE_EXECUTION,
  1451. "enable_code_interpreter": app.state.config.ENABLE_CODE_INTERPRETER,
  1452. "enable_image_generation": app.state.config.ENABLE_IMAGE_GENERATION,
  1453. "enable_autocomplete_generation": app.state.config.ENABLE_AUTOCOMPLETE_GENERATION,
  1454. "enable_community_sharing": app.state.config.ENABLE_COMMUNITY_SHARING,
  1455. "enable_message_rating": app.state.config.ENABLE_MESSAGE_RATING,
  1456. "enable_user_webhooks": app.state.config.ENABLE_USER_WEBHOOKS,
  1457. "enable_admin_export": ENABLE_ADMIN_EXPORT,
  1458. "enable_admin_chat_access": ENABLE_ADMIN_CHAT_ACCESS,
  1459. "enable_google_drive_integration": app.state.config.ENABLE_GOOGLE_DRIVE_INTEGRATION,
  1460. "enable_onedrive_integration": app.state.config.ENABLE_ONEDRIVE_INTEGRATION,
  1461. **(
  1462. {
  1463. "enable_onedrive_personal": ENABLE_ONEDRIVE_PERSONAL,
  1464. "enable_onedrive_business": ENABLE_ONEDRIVE_BUSINESS,
  1465. }
  1466. if app.state.config.ENABLE_ONEDRIVE_INTEGRATION
  1467. else {}
  1468. ),
  1469. }
  1470. if user is not None
  1471. else {}
  1472. ),
  1473. },
  1474. **(
  1475. {
  1476. "default_models": app.state.config.DEFAULT_MODELS,
  1477. "default_prompt_suggestions": app.state.config.DEFAULT_PROMPT_SUGGESTIONS,
  1478. "user_count": user_count,
  1479. "code": {
  1480. "engine": app.state.config.CODE_EXECUTION_ENGINE,
  1481. },
  1482. "audio": {
  1483. "tts": {
  1484. "engine": app.state.config.TTS_ENGINE,
  1485. "voice": app.state.config.TTS_VOICE,
  1486. "split_on": app.state.config.TTS_SPLIT_ON,
  1487. },
  1488. "stt": {
  1489. "engine": app.state.config.STT_ENGINE,
  1490. },
  1491. },
  1492. "file": {
  1493. "max_size": app.state.config.FILE_MAX_SIZE,
  1494. "max_count": app.state.config.FILE_MAX_COUNT,
  1495. "image_compression": {
  1496. "width": app.state.config.FILE_IMAGE_COMPRESSION_WIDTH,
  1497. "height": app.state.config.FILE_IMAGE_COMPRESSION_HEIGHT,
  1498. },
  1499. },
  1500. "permissions": {**app.state.config.USER_PERMISSIONS},
  1501. "google_drive": {
  1502. "client_id": GOOGLE_DRIVE_CLIENT_ID.value,
  1503. "api_key": GOOGLE_DRIVE_API_KEY.value,
  1504. },
  1505. "onedrive": {
  1506. "client_id_personal": ONEDRIVE_CLIENT_ID_PERSONAL,
  1507. "client_id_business": ONEDRIVE_CLIENT_ID_BUSINESS,
  1508. "sharepoint_url": ONEDRIVE_SHAREPOINT_URL.value,
  1509. "sharepoint_tenant_id": ONEDRIVE_SHAREPOINT_TENANT_ID.value,
  1510. },
  1511. "ui": {
  1512. "pending_user_overlay_title": app.state.config.PENDING_USER_OVERLAY_TITLE,
  1513. "pending_user_overlay_content": app.state.config.PENDING_USER_OVERLAY_CONTENT,
  1514. "response_watermark": app.state.config.RESPONSE_WATERMARK,
  1515. },
  1516. "license_metadata": app.state.LICENSE_METADATA,
  1517. **(
  1518. {
  1519. "active_entries": app.state.USER_COUNT,
  1520. }
  1521. if user.role == "admin"
  1522. else {}
  1523. ),
  1524. }
  1525. if user is not None and (user.role in ["admin", "user"])
  1526. else {
  1527. **(
  1528. {
  1529. "ui": {
  1530. "pending_user_overlay_title": app.state.config.PENDING_USER_OVERLAY_TITLE,
  1531. "pending_user_overlay_content": app.state.config.PENDING_USER_OVERLAY_CONTENT,
  1532. }
  1533. }
  1534. if user and user.role == "pending"
  1535. else {}
  1536. ),
  1537. **(
  1538. {
  1539. "metadata": {
  1540. "login_footer": app.state.LICENSE_METADATA.get(
  1541. "login_footer", ""
  1542. ),
  1543. "auth_logo_position": app.state.LICENSE_METADATA.get(
  1544. "auth_logo_position", ""
  1545. ),
  1546. }
  1547. }
  1548. if app.state.LICENSE_METADATA
  1549. else {}
  1550. ),
  1551. }
  1552. ),
  1553. }
  1554. class UrlForm(BaseModel):
  1555. url: str
  1556. @app.get("/api/webhook")
  1557. async def get_webhook_url(user=Depends(get_admin_user)):
  1558. return {
  1559. "url": app.state.config.WEBHOOK_URL,
  1560. }
  1561. @app.post("/api/webhook")
  1562. async def update_webhook_url(form_data: UrlForm, user=Depends(get_admin_user)):
  1563. app.state.config.WEBHOOK_URL = form_data.url
  1564. app.state.WEBHOOK_URL = app.state.config.WEBHOOK_URL
  1565. return {"url": app.state.config.WEBHOOK_URL}
  1566. @app.get("/api/version")
  1567. async def get_app_version():
  1568. return {
  1569. "version": VERSION,
  1570. }
  1571. @app.get("/api/version/updates")
  1572. async def get_app_latest_release_version(user=Depends(get_verified_user)):
  1573. if not ENABLE_VERSION_UPDATE_CHECK:
  1574. log.debug(
  1575. f"Version update check is disabled, returning current version as latest version"
  1576. )
  1577. return {"current": VERSION, "latest": VERSION}
  1578. try:
  1579. timeout = aiohttp.ClientTimeout(total=1)
  1580. async with aiohttp.ClientSession(timeout=timeout, trust_env=True) as session:
  1581. async with session.get(
  1582. "https://api.github.com/repos/open-webui/open-webui/releases/latest",
  1583. ssl=AIOHTTP_CLIENT_SESSION_SSL,
  1584. ) as response:
  1585. response.raise_for_status()
  1586. data = await response.json()
  1587. latest_version = data["tag_name"]
  1588. return {"current": VERSION, "latest": latest_version[1:]}
  1589. except Exception as e:
  1590. log.debug(e)
  1591. return {"current": VERSION, "latest": VERSION}
  1592. @app.get("/api/changelog")
  1593. async def get_app_changelog():
  1594. return {key: CHANGELOG[key] for idx, key in enumerate(CHANGELOG) if idx < 5}
  1595. @app.get("/api/usage")
  1596. async def get_current_usage(user=Depends(get_verified_user)):
  1597. """
  1598. Get current usage statistics for Open WebUI.
  1599. This is an experimental endpoint and subject to change.
  1600. """
  1601. try:
  1602. return {"model_ids": get_models_in_use(), "user_ids": get_active_user_ids()}
  1603. except Exception as e:
  1604. log.error(f"Error getting usage statistics: {e}")
  1605. raise HTTPException(status_code=500, detail="Internal Server Error")
  1606. ############################
  1607. # OAuth Login & Callback
  1608. ############################
  1609. # SessionMiddleware is used by authlib for oauth
  1610. if len(OAUTH_PROVIDERS) > 0:
  1611. try:
  1612. # Try to create Redis store for sessions
  1613. if REDIS_URL:
  1614. redis_session_store = RedisStore(
  1615. url=REDIS_URL,
  1616. prefix=(
  1617. f"{REDIS_KEY_PREFIX}:session:" if REDIS_KEY_PREFIX else "session:"
  1618. ),
  1619. )
  1620. # Add SessionAutoloadMiddleware first to handle session loading
  1621. app.add_middleware(SessionAutoloadMiddleware)
  1622. app.add_middleware(
  1623. StarSessionsMiddleware,
  1624. store=redis_session_store,
  1625. cookie_name="oui-session",
  1626. cookie_same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  1627. cookie_https_only=WEBUI_SESSION_COOKIE_SECURE,
  1628. )
  1629. log.info("Using StarSessions with Redis for session management")
  1630. else:
  1631. raise ValueError("Redis URL not configured")
  1632. except Exception as e:
  1633. log.warning(
  1634. f"Failed to initialize Redis sessions, falling back to cookie based sessions: {e}"
  1635. )
  1636. # Fallback to existing SessionMiddleware
  1637. app.add_middleware(
  1638. SessionMiddleware,
  1639. secret_key=WEBUI_SECRET_KEY,
  1640. session_cookie="oui-session",
  1641. same_site=WEBUI_SESSION_COOKIE_SAME_SITE,
  1642. https_only=WEBUI_SESSION_COOKIE_SECURE,
  1643. )
  1644. @app.get("/oauth/{provider}/login")
  1645. async def oauth_login(provider: str, request: Request):
  1646. return await oauth_manager.handle_login(request, provider)
  1647. # OAuth login logic is as follows:
  1648. # 1. Attempt to find a user with matching subject ID, tied to the provider
  1649. # 2. If OAUTH_MERGE_ACCOUNTS_BY_EMAIL is true, find a user with the email address provided via OAuth
  1650. # - This is considered insecure in general, as OAuth providers do not always verify email addresses
  1651. # 3. If there is no user, and ENABLE_OAUTH_SIGNUP is true, create a user
  1652. # - Email addresses are considered unique, so we fail registration if the email address is already taken
  1653. @app.get("/oauth/{provider}/callback")
  1654. async def oauth_callback(provider: str, request: Request, response: Response):
  1655. return await oauth_manager.handle_callback(request, provider, response)
  1656. @app.get("/manifest.json")
  1657. async def get_manifest_json():
  1658. if app.state.EXTERNAL_PWA_MANIFEST_URL:
  1659. return requests.get(app.state.EXTERNAL_PWA_MANIFEST_URL).json()
  1660. else:
  1661. return {
  1662. "name": app.state.WEBUI_NAME,
  1663. "short_name": app.state.WEBUI_NAME,
  1664. "description": f"{app.state.WEBUI_NAME} is an open, extensible, user-friendly interface for AI that adapts to your workflow.",
  1665. "start_url": "/",
  1666. "display": "standalone",
  1667. "background_color": "#343541",
  1668. "icons": [
  1669. {
  1670. "src": "/static/logo.png",
  1671. "type": "image/png",
  1672. "sizes": "500x500",
  1673. "purpose": "any",
  1674. },
  1675. {
  1676. "src": "/static/logo.png",
  1677. "type": "image/png",
  1678. "sizes": "500x500",
  1679. "purpose": "maskable",
  1680. },
  1681. ],
  1682. }
  1683. @app.get("/opensearch.xml")
  1684. async def get_opensearch_xml():
  1685. xml_content = rf"""
  1686. <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  1687. <ShortName>{app.state.WEBUI_NAME}</ShortName>
  1688. <Description>Search {app.state.WEBUI_NAME}</Description>
  1689. <InputEncoding>UTF-8</InputEncoding>
  1690. <Image width="16" height="16" type="image/x-icon">{app.state.config.WEBUI_URL}/static/favicon.png</Image>
  1691. <Url type="text/html" method="get" template="{app.state.config.WEBUI_URL}/?q={"{searchTerms}"}"/>
  1692. <moz:SearchForm>{app.state.config.WEBUI_URL}</moz:SearchForm>
  1693. </OpenSearchDescription>
  1694. """
  1695. return Response(content=xml_content, media_type="application/xml")
  1696. @app.get("/health")
  1697. async def healthcheck():
  1698. return {"status": True}
  1699. @app.get("/health/db")
  1700. async def healthcheck_with_db():
  1701. Session.execute(text("SELECT 1;")).all()
  1702. return {"status": True}
  1703. app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
  1704. @app.get("/cache/{path:path}")
  1705. async def serve_cache_file(
  1706. path: str,
  1707. user=Depends(get_verified_user),
  1708. ):
  1709. file_path = os.path.abspath(os.path.join(CACHE_DIR, path))
  1710. # prevent path traversal
  1711. if not file_path.startswith(os.path.abspath(CACHE_DIR)):
  1712. raise HTTPException(status_code=404, detail="File not found")
  1713. if not os.path.isfile(file_path):
  1714. raise HTTPException(status_code=404, detail="File not found")
  1715. return FileResponse(file_path)
  1716. def swagger_ui_html(*args, **kwargs):
  1717. return get_swagger_ui_html(
  1718. *args,
  1719. **kwargs,
  1720. swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
  1721. swagger_css_url="/static/swagger-ui/swagger-ui.css",
  1722. swagger_favicon_url="/static/swagger-ui/favicon.png",
  1723. )
  1724. applications.get_swagger_ui_html = swagger_ui_html
  1725. if os.path.exists(FRONTEND_BUILD_DIR):
  1726. mimetypes.add_type("text/javascript", ".js")
  1727. app.mount(
  1728. "/",
  1729. SPAStaticFiles(directory=FRONTEND_BUILD_DIR, html=True),
  1730. name="spa-static-files",
  1731. )
  1732. else:
  1733. log.warning(
  1734. f"Frontend build directory not found at '{FRONTEND_BUILD_DIR}'. Serving API only."
  1735. )