main.py 49 KB

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