main.py 46 KB

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