main.py 48 KB

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