main.py 57 KB

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